Skip to content

Commit

Permalink
Update CONTRIBUTING.MD
Browse files Browse the repository at this point in the history
  • Loading branch information
LukasPrediger committed Aug 5, 2024
1 parent 6a62779 commit f5eead6
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@ Feel free to open Issues for any Discussions, Bugs or Improvements. Please adher

2. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the Repository using the standard workflow and set up a new branch to work in. Make sure that each group of changes is done in a separate branch, so that PRs only contain relevant changes

3. This Project uses [RustFmt](https://github.com/rust-lang/rustfmt) to ensure proper formatting. PRs that do not adhere to the formatting will not be able to be merged! The formatting can be done using `cargo fmt --all`. If you are using IntelliJ Idea for developing you can set up RustFmt using the `Languages&Frameworks > Rust > RustFmt` settings
3. Make sure all compiler checks pass by running `cargo check --tests --examples`

4. This Project uses [Clippy](https://github.com/rust-lang/rust-clippy) as a code linter. Execute it before committing using `cargo clippy -- -D warnings`. Intellij allows you to run Clippy while developing, to find linter errors as they happen
4. This Project uses [RustFmt](https://github.com/rust-lang/rustfmt) to ensure proper formatting. PRs that do not adhere to the formatting will not be able to be merged! The formatting can be done using `cargo fmt --all`. If you are using IntelliJ Idea for developing you can set up RustFmt using the `Languages&Frameworks > Rust > RustFmt` settings

5. All significant changes should be accompanied by tests. If you are unsure about testing, take a look at existing tests. Make sure all tests run before creating a PR using `cargo test`
5. This Project uses [Clippy](https://github.com/rust-lang/rust-clippy) as a code linter. Execute it before committing using `cargo clippy -- -D warnings`. Intellij allows you to run Clippy while developing, to find linter errors as they happen

6. Finally, push your commits to your fork and submit a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). Summarize your changes in the Description of the Pull Request
6. All significant changes should be accompanied by tests. If you are unsure about testing, take a look at existing tests. Make sure all tests run before creating a PR using `cargo test`

7. All check can be quickly run using the [just](https://github.com/casey/just) command runner. Running `just ci` will execute all checks required to pass the pr checks

8. Finally, push your commits to your fork and submit a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). Summarize your changes in the Description of the Pull Request

0 comments on commit f5eead6

Please sign in to comment.