orhun/git-cliff
1
1
Fork 0
mirror of https://github.com/orhun/git-cliff.git synced 2024-12-01 23:32:18 +03:00
Code Issues Projects Releases Wiki Activity
8bebbf9f57
git-cliff/CONTRIBUTING.md
Nejc Galof a82dac3cb1
docs(contributing): mention fetching the tags for running tests successfully (#850) 
* docs(contributing): mention the tags are necessary for running tests successfully

* docs(contributing): Update file based on the review

* Update CONTRIBUTING.md

---------

Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
2024-09-14 21:58:24 +03:00

2.3 KiB
Raw Blame History

Contributing

Thank you for considering contributing to git-cliff!

When contributing, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Note that we have a Code of Conduct, please follow it in all your interactions with the project.

Setup

  1. Fork this repository and create your branch from main.

  2. Clone your forked repository.

git clone https://github.com/{username}/git-cliff && cd git-cliff

To ensure the successful execution of the tests, it is essential to fetch the tags as follows:

git fetch --tags https://github.com/orhun/git-cliff
  1. Make sure that you have Rust 1.64.0 or later installed and build the project.
cargo build

  1. Start committing your changes. Follow the conventional commit specification while doing so.

  2. Add your tests (if you haven't already) or update the existing tests according to the changes. And check if the tests are passed.

cargo test
  1. If needed, update the snapshot tests (i.e. tests using expect_test):
env UPDATE_EXPECT=1 cargo test
  1. Make sure rustfmt and clippy don't complain about your changes.

We use the nightly channel for rustfmt so please set the appropriate settings for your editor/IDE for that.

Create a Pull Request

  1. Ensure that you updated the documentation and filled the Pull Request template according to the changes you made.

  2. Wait for approval from the project owner/maintainer. Discuss the possible changes and update your Pull Request if necessary.

  3. You may merge the Pull Request once you have the sign-off of the project owner/maintainer, or if you do not have permission to do that, you may request the project owner/maintainer to merge it in case they haven't done it after a while.

License

By contributing, you agree that your contributions will be licensed under The MIT License or Apache License 2.0.