Skip to content

Commit

Permalink
Fix typos (#213)
Browse files Browse the repository at this point in the history
  • Loading branch information
ShubhamVG authored Sep 23, 2024
1 parent 3179bc0 commit d8b9e72
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Unless you explicitly state otherwise, any contribution intentionally submitted

1. Join [slack](https://join.slack.com/t/rencfs/shared_invite/zt-2o4l1tdkk-VJeWIbO2p6zgeafDISPHbQ)
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** os that you can work on issues and be able to create your own branches and not needing to fork the repo
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
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**
6. Make the changes in your branch
Expand All @@ -13,9 +13,9 @@ Unless you explicitly state otherwise, any contribution intentionally submitted
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)
10. `cargo clippy --all --release` and fix any erorrs
10. `cargo clippy --all --release` and fix any errors
11. **DON'T INCREASE THE VERSION NUMBER IN `Cargo.toml`, WE WILL DO THAN WHEN RELEASING**
12. Create a `git` `commit hook` file in `.git/hooks/pre-commit` with [this](hooks/linux-macos/pre-commit) content on `Linux` and `MacOS`, and [this](hooks/windows/pre-commit) on `Windows`. Make it executable in Linux and macO with `chmod +x .git/hooks/pre-commit` .This will run when you do `git commit` and will make the commit to be quite slow, but please give it time to complete as this helps to fix any issues locally and not relying just on running `ci` on GitHub when you create the PR
12. Create a `git` `commit hook` file in `.git/hooks/pre-commit` with [this](hooks/linux-macos/pre-commit) content on `Linux` and `MacOS`, and [this](hooks/windows/pre-commit) on `Windows`. Make it executable in Linux and macOS with `chmod +x .git/hooks/pre-commit` .This will run when you do `git commit` and will make the commit to be quite slow, but please give it time to complete as this helps to fix any issues locally and not relying just on running `ci` on GitHub when you create the PR
13. Commit your changes and if there are any errors fix them before you push them
14. Push your changes and create a `PR` back to the `parent` repo targeting the `main` branch and request review from owners of the repository
15. Monitor the checks (GitHub actions runs) and fix the code if they are failing
Expand Down

0 comments on commit d8b9e72

Please sign in to comment.