From 792d5d51d46c58b2a95947989fd2f10077de11bc Mon Sep 17 00:00:00 2001 From: Radu Marias Date: Tue, 30 Jul 2024 21:49:07 +0300 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c377f80..6c8c904 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,14 +2,15 @@ 1. Fork the repo 2. Make sure there is an open issue or a task in the [project](https://github.com/users/radumarias/projects/4) -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/rencrypt-python/blob/main/src/lib.rs#L1-L17) as first ones -6. If you add new packages to the workspace add all these [lines](https://github.com/radumarias/rencrypt-python/blob/main/src/lib.rs#L1-L17) to it's `lib.rs` +3. **Ask the owner of the project to add your GitHub username to the project** +4. **Assign the issues you are woeking to you and move them in the corresponding status column as you are working on it. If the taks is not an issue yet, convert it to issue first** +5. Make the changes in your fork +6. If you add new `.rs` files in `examples` member add all these [lines](https://github.com/radumarias/rencrypt-python/blob/main/src/lib.rs#L1-L17) as first ones +7. If you add new packages to the workspace add all these [lines](https://github.com/radumarias/rencrypt-python/blob/main/src/lib.rs#L1-L17) 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 +8. Add tests for your changes, if applicable +9. `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) 0. Create a **PR** back to **main** repo to the `main` branch