Skip to content

Commit

Permalink
cargo fmt and cargo clippy on Github Actions (#37)
Browse files Browse the repository at this point in the history
Automatically block PRs which deviate from well formatted and/or
warning-free code.
  • Loading branch information
toasterparty authored May 16, 2024
1 parent ecf334a commit 3e4eadd
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ name: Rust

on:
push:
branches:
- main
pull_request:

jobs:
Expand Down
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,24 @@ Updates to this program are documented as part of the [py-randomprime Release Pr

That should create a standalone executable in `./randomprime/target/debug/randomprime_patcher.exe`.

Occasionally run `rustup update` to keep your toolchain version up-to-date.

## Contributing

In order to pass this project's Pull Request requirements, your proposed change must pass the following checks:

```sh
cargo fmt --check
cargo clippy -- -D warnings
```

You can use these commands to fix most issues automatically:

```sh
cargo fmt
cargo clippy --fix --allow-dirty
```

## Resources

Some helpful resources for those starting out with modding Metroid Prime can be found in the [Metroid Prime Fanhacks](https://github.com/toasterparty/metroid-prime-fanhacks/tree/main/doc#resources) repository. Furthermore there's:
Expand Down

0 comments on commit 3e4eadd

Please sign in to comment.