Skip to content

Commit 43caedc

Browse files
authored
Merge pull request #292 from Smankusors/conventional-pls
Make conventional commits more explicit
2 parents e344d62 + 190401c commit 43caedc

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<!-- Go over all the following points, and put an `x` in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
1616

1717
- [ ] I have read the **[CONTRIBUTING document](https://github.com/materializecss/materialize/blob/main/CONTRIBUTING.md)**.
18-
- [ ] My change requires a change to the documentation.
19-
- [ ] I have updated the documentation accordingly.
18+
- [ ] My commit messages follows the [conventional commit format](https://github.com/materializecss/materialize/blob/main/CONTRIBUTING.md#submitting-your-pull-request)
19+
- [ ] My change requires a change to the documentation, and updated it accordingly.
2020
- [ ] I have added tests to cover my changes.
2121
- [ ] All new and existing tests passed.

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,8 @@ Adhering to the following process is the best way to get your work included in t
139139
git checkout -b <topic-branch-name>
140140
```
141141

142-
4. Commit your changes in logical chunks with messages written in English. Please adhere to these [git commit message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) and use [conventional commit format](https://github.com/conventional-changelog/commitlint/#what-is-commitlint) in your commit messages (or use `npm run commit` to make your life easier). Failing to do this makes your commits unlikely to be merged into the main project.
142+
4. Commit your changes in logical chunks with messages written in English. Please adhere to these [git commit message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) and use [conventional commit format](https://github.com/conventional-changelog/commitlint/#what-is-commitlint) in your commit messages. Failing to do this makes your commits unlikely to be merged into the main project.
143+
> You can use `npm run commit` to help you formatting the message, or use [commitlint.io](https://commitlint.io) if you are not editing locally
143144
144145
5. Locally merge (or rebase) the upstream development branch into your topic branch:
145146

0 commit comments

Comments
 (0)