-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from radumarias/radumarias-patch-2
Update CONTRIBUTING.md
- Loading branch information
Showing
1 changed file
with
2 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,4 @@ | ||
## 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/6) | ||
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/zeroize-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/zeroize-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]]`) | ||
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) | ||
10. Create a **PR** back to **main** repo to the `main` branch | ||
11. Monitor the checks (GitHub actions run) | ||
12. Respond to any comments | ||
13. In the end, ideally, it will be merged to `main` | ||
You can use this [CONTRIBUTING](https://github.com/radumarias/rencfs/blob/main/CONTRIBUTING.md) guide as a reference, skipping the steps that don't apply. | ||
|