Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit b5affc8

Browse files
authored
Create CONTRIBUTING.md
1 parent a04064b commit b5affc8

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## How to contribute
2+
3+
1. Fork the repo
4+
2. Make sure there is an open issue or a task in the [project](https://github.com/users/radumarias/projects/6)
5+
3. **Assign it to you and move it in the corresponding status column as you are working on it**
6+
4. Make the changes in your fork
7+
5. If you add new `.rs` files in `examples` member add all these [lines](https://github.com/radumarias/zeroize-python/blob/main/src/lib.rs#L1-L17) as first ones
8+
6. If you add new packages to the workspace add all these [lines](https://github.com/radumarias/zeroize-python/blob/main/src/lib.rs#L1-L17) to it's `lib.rs`
9+
and to any `bin` files (
10+
like `main.rs` or other files declared as `[[bin]]`)
11+
7. Add tests for your changes, if applicable
12+
8. `cargo fmt --all`, you can configure your **IDE** to do this on
13+
save, [RustRover](https://www.jetbrains.com/help/rust/rustfmt.html)
14+
and [VSCode](https://code.visualstudio.com/docs/languages/rust#_formatting)
15+
9. `./check-before-push.sh` or `cmd /c check-before-push.bat` and fix any errors
16+
10. Create a **PR** back to **main** repo to the `main` branch
17+
11. Monitor the checks (GitHub actions run)
18+
12. Respond to any comments
19+
13. In the end, ideally, it will be merged to `main`

0 commit comments

Comments
 (0)