Skip to content
This repository was archived by the owner on May 14, 2025. It is now read-only.

Commit b6775e2

Browse files
authored
docs(contribution guide): add requirements about commit and PR naming (#133)
docs(contribution guide): add requirements about commit and PR naming Signed-off-by: grzesuav <grzesuav@gmail.com>
1 parent 30e60aa commit b6775e2

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Pull Request template
2+
Please, go through these steps before you submit a PR.
3+
4+
1. This repository follows semantic versioning convention, therefore each PR title/commit message must follow convention: `<type>(<scope>): [#issue_number] - <subject>`.
5+
`type` is defining if release will be triggering after merging submitted changes, details in [CONTRIBUTING.md](../CONTRIBUTING.md). `#issue_number` is optional, when commit resolves any github issue.
6+
Most common types are:
7+
* `feat` - for new features
8+
* `fix` - for bug fixes or improvements
9+
* `chore` - changes not related to code
10+
11+
12+
13+
IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines.
14+
15+
**PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING**

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,17 @@ You generally only need to submit a CLA once, so if you've already submitted one
1313
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult
1414
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests.
1515

16+
## Commit messages
17+
18+
This repository uses [semantic versioning](https://semver.org/), therefore every commit and PR must follow naming convention. We require commit header to be in form `<type>(<scope>): [#issue_number] - <subject>`, where `type`, `scope` and
19+
`subject` as defined in [angular commit message convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#type). `#issue_number` is optional, if commit resolves any gihub issue.
20+
21+
Please be aware that new release will be triggered for:
22+
* `feat` - minor release
23+
* `perf/fix` - patch release
24+
25+
where minor/patch as in semantic versioning definition.
26+
1627
## Contributor Guide
1728

1829
Aside from the above administrative requirements, you can find more

0 commit comments

Comments
 (0)