Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
radumarias authored Nov 26, 2024
1 parent 9808be5 commit 657612d
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
## How to contribute

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as
defined in the Apache License, shall be dual-licensed as above, without any additional terms or conditions.
> [!IMPORTANT]
> **These steps are more particular to this repo but mainly apply to all repositories; change the specifics.**
Unless you explicitly state otherwise, any Contribution intentionally submitted for inclusion in this project by you, as
defined in the Apache License shall be dual-licensed as above, without any additional terms or conditions.

1. Join [slack](https://bit.ly/3UU1oXi) and join `#dev-beginners` channel
2. Become familiar with docs and code by reading the [ramp-up](Ramp-up.md) guide
3. **Ask the owner of the repository to add your GitHub username to the repository** so that you can work on issues and
be able to create your own branches and not needing to fork the repo
be able to create your own branches and not need to fork the repo
4. Pick an open issue or a task in the corresponding [project](https://github.com/users/radumarias/projects/1) for the
repo that you'll be working on. You can
see [good for first issues](https://github.com/radumarias/rencfs/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
that you can pick from
5. **Assign the issues you are working on to you and move them to the corresponding status column as you are progressing
on them. If the taks is not an issue yet, convert it to issue first**
on them. If the task is not an issue yet, convert it to issue first**
6. Make the changes in your branch
7. Add docs as they apply
8. Add tests, benchmarks and examples for your changes, if applicable
8. Add tests, benchmarks, and examples for your changes, if applicable
9. `cargo fmt --all` to format the code. 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)
Expand All @@ -24,13 +27,13 @@ defined in the Apache License, shall be dual-licensed as above, without any addi
12. Create a `git` `push hook` file in `.git/hooks/pre-push` with [this](git-hooks/linux-macos/pre-push) content
on `Linux` and `MacOS`, and [this](git-hooks/windows/pre-push) on `Windows`.
Make it executable in Linux and macOS
with `chmod +x .git/hooks/pre-push` .This will run when you do `git push` and will make the push to be quite
slow, but please give it time to complete as this helps to fix any issues locally and not relying just on
with `chmod +x .git/hooks/pre-push` .This will run when you do `git push` and will make the push quite
slow, but please give it time to complete as this helps to fix any issues locally and not rely just on
running `ci` on GitHub when you create the PR
13. Commit and push your changes and if there are any errors, fix them before you push them
13. Commit and push your changes, and if there are any errors, fix them before you push them
14. Create a `PR` back to the `parent` repo targeting the `main` branch and request review from
owners of the repository, by adding them to the `Reviewers` field
owners of the repository by adding them to the `Reviewers` field
15. Monitor the checks (GitHub actions runs) and fix the code if they are failing
16. Respond to any comments
17. **DON'T MERGE THE PR YOURSELF, LEAVE THAT TO REPOSITORY OWNERS**
18. In the end, ideally, it will be merged to `main`
17. **DON'T MERGE THE PR YOURSELF. LEAVE THAT TO REPOSITORY OWNERS**
18. In the end, ideally, it will be merged into `main`

0 comments on commit 657612d

Please sign in to comment.