Skip to content

Commit

Permalink
Merge pull request #1 from radumarias/radumarias-patch-2
Browse files Browse the repository at this point in the history
Update CONTRIBUTING.md
  • Loading branch information
radumarias authored Jul 30, 2024
2 parents eff0dbd + 4cd9149 commit 92ac534
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,18 @@

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/syncoxiders/blob/main/file-tree-merge/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/syncoxiders/blob/main/file-tree-merge/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/syncoxiders/blob/main/file-tree-merge/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/syncoxiders/blob/main/file-tree-merge/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)
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`
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`

0 comments on commit 92ac534

Please sign in to comment.