diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1e11e4a644e..a6d16a0787e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,7 @@ New to our project? [Make your first contribution](#your-first-code-contribution - Ensure you follow our [style guides](#style-guides) for code and documentation. - Write [tests](https://doc.rust-lang.org/cargo/commands/cargo-test.html). Ensure they all pass (`cargo test --workspace`). - Perform pre-commit routine like formatting & artifacts regeneration (see [`pre-commit.sample`](./hooks/pre-commit.sample)) -- With the `upstream` set to track [Hyperledger Iroha repository](https://github.com/hyperledger/iroha), `git pull -r upstream main`, `git commit -s`, `git push `, and [create a pull request](https://github.com/hyperledger/iroha/compare) to the `main` branch. Ensure the PR has the `type: Description` [title](#pull-request-titles). +- With the `upstream` set to track [Hyperledger Iroha repository](https://github.com/hyperledger/iroha), `git pull -r upstream main`, `git commit -s`, `git push `, and [create a pull request](https://github.com/hyperledger/iroha/compare) to the `main` branch. Ensure the PR has the `: ` [title](#pull-request-titles). ### Reporting Bugs @@ -92,7 +92,11 @@ If you intend to implement the suggestion yourself, do the following: 3. When you are ready to open a pull request, make sure you follow the [pull request guidelines](#pull-request-etiquette) and mark it as implementing the previously created issue: ``` - feat: Description + feat: Description of the feature + + Explanation of the feature + + Closes #1234 ``` 4. If your change requires an API change, use the `api-changes` tag. @@ -215,7 +219,7 @@ Follow these commit guidelines: You may use [the `commit-msg` hook](./hooks/) to automatically sign-off your commits. -- Follow the same naming schema as for [pull request titles](#pull-request-titles): `type: Description`. This means: +- Follow the same naming schema as for [pull request titles](#pull-request-titles): `: `. This means: - **Use present tense** ("Add feature", not "Added feature") - **Use imperative mood** ("Deploy to docker..." not "Deploys to docker...") - Write a meaningful commit message.