Skip to content

Commit

Permalink
docs: update the contributing guide
Browse files Browse the repository at this point in the history
Signed-off-by: Mukul Kolpe <mukulkolpe45@gmail.com>
  • Loading branch information
MukulKolpe committed May 21, 2024
1 parent fce4cf2 commit 91aacd1
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <your-fork>`, 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 <your-fork>`, 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).

### Reporting Bugs

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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): `<type>: <description>`. 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.
Expand Down

0 comments on commit 91aacd1

Please sign in to comment.