Skip to content

Commit

Permalink
docs: update documentation with commitlint details (electrode-io#1934)
Browse files Browse the repository at this point in the history
* docs: update documentation with commitlint details
  • Loading branch information
arunvishnun committed Mar 22, 2023
1 parent 7c0234a commit 5c33b69
Show file tree
Hide file tree
Showing 2 changed files with 94 additions and 92 deletions.
14 changes: 5 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,25 +65,21 @@ We are using [prettier] to format all our code with only one custom setting: `--
#### PR and Commit messages

Since we use independent lerna mode, to help keep the changelog clear, please format all your commit message with the following guideline:
Since we use commitlint, keep the changelog clear, please format all your commit message with the following guideline:

`[<semver>][feat|bug|chore] <message>`

- `<semver>` can be:
- `major` - `maj` or `major`
- `minor` - `min` or `minor`
- `patch` - `pat` or `patch`
- Only include `[feat|bug|chore]` if it's applicable.
- Only include `feat|bug|chore` if it's applicable.
- Please format your PR's title with the same format.

> **_Please do everything you can to keep commits for a PR to a single package in `packages`._**
A sample commit and PR message should look like:

```text
[minor][feat] implement support for react-query
feat: implement support for react-query
```

Read more about commitlint - https://github.com/conventional-changelog/commitlint/#what-is-commitlint

### Filing Issues

If you need help or found an issue, please [submit a github issue](https://github.com/electrode-io/electrode/issues/new/choose).
Expand Down
Loading

0 comments on commit 5c33b69

Please sign in to comment.