From 6a627795ed2a64a8e09173c6fd0df49a543b080a Mon Sep 17 00:00:00 2001 From: lukas prediger Date: Thu, 15 Sep 2022 15:38:29 +0200 Subject: [PATCH 1/2] Create CONTRIBUTING.md --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9f533a5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing + +## Reporting Issues +Feel free to open Issues for any Discussions, Bugs or Improvements. Please adhere to the provided Templates and provide the required context. + +## Pull Request Process +1. Please open an Issue describing the bug or feature you are intending to fix. If you are working on an existing Issue comment on relevant Issue in order to let other Contributors know that you are working on it + +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 + +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 + +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` + +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 \ No newline at end of file From f5eead6bc6c68e8a7e04a912fb67789be22942b3 Mon Sep 17 00:00:00 2001 From: Lukas Prediger Date: Mon, 5 Aug 2024 15:11:09 +0200 Subject: [PATCH 2/2] Update CONTRIBUTING.MD --- CONTRIBUTING.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f533a5..ae784a9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 \ No newline at end of file +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 \ No newline at end of file