From ad170abd06c539ef6ddcdd4e5b9a5b0bb7d7df00 Mon Sep 17 00:00:00 2001 From: Radu Marias Date: Tue, 30 Jul 2024 19:10:29 +0300 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9c37120 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +## How to contribute + +1. Fork the repo +2. Make sure there is an open issue or a task in the [project](https://github.com/users/radumarias/projects/7/views/1) +3. **Assign it to you and move it in the corresponding status column as you are working on it** +4. Make the changes in your fork +5. If you add new `.rs` files in `examples` member add all these [lines](https://github.com/radumarias/rencfs/blob/main/src/lib.rs#L1-L16) as first ones +6. If you add new packages to the workspace add all these [lines](https://github.com/radumarias/rencfs/blob/main/src/lib.rs#L1-L16) to it's `lib.rs` + and to any `bin` files ( + like `main.rs` or other files declared as `[[bin]]`) +7. Add tests for your changes, if applicable +8. `cargo fmt --all`, you can configure your **IDE** to do this on + save, [RustRover](https://www.jetbrains.com/help/rust/rustfmt.html) + and [VSCode](https://code.visualstudio.com/docs/languages/rust#_formatting) +9. Create a **PR** back to **main** repo to the `main` branch +10. Monitor the checks (GitHub actions run) +11. Respond to any comments +12. In the end, ideally, it will be merged to `main`