Skip to content

Commit

Permalink
chore: Add more commit prefixes and update README file (#227)
Browse files Browse the repository at this point in the history
  • Loading branch information
mpro7 authored Sep 5, 2024
1 parent 374389b commit 704a44b
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 35 deletions.
45 changes: 24 additions & 21 deletions .github/release-please/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,45 @@
"release-type": "rust",
"changelog-sections": [
{
"type": "feat",
"section": "Enhancements",
"hidden": false
"type": "build",
"section": "Maintenances"
},
{
"type": "fix",
"section": "Bug Fixes",
"hidden": false
"type": "chore",
"section": "Maintenances"
},
{
"type": "chore",
"section": "Maintenance",
"hidden": false
"type": "docs",
"section": "Documentation"
},
{
"type": "build",
"section": "Maintenance",
"hidden": false
"type": "feat",
"section": "Enhancements"
},
{
"type": "docs",
"section": "Documentation",
"hidden": false
"type": "fix",
"section": "Bug Fixes"
},
{
"type": "data",
"section": "Project Data",
"hidden": false
"type": "perf",
"section": "Performance Improvements"
},
{
"type": "refactor",
"section": "Maintenance",
"hidden": false
"section": "Maintenances"
},
{
"type": "test",
"section": "Tests"
},
{
"type": "style",
"section": "Styles"
}
],
"plugins": ["sentence-case"],
"plugins": [
"sentence-case"
],
"packages": {
".": {
"changelog-path": "CHANGELOG.md",
Expand Down
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,19 @@ The most important prefixes you should have in mind are:
- `feat!:`, or `fix!:`, `refactor!:`, etc., which represent a breaking change
(indicated by the `!`) and will result in a SemVer major.

This is the complete list of what is defined and if it is visible in the
changelog:

- 'feat' -> section: 'Features'
- 'feature' -> section: 'Features'
Here is the complete list of prefixes used in this repository with
corresponding sections in the changelog:

- 'build' -> section: 'Maintenances'
- 'chore' -> section: 'Maintenances'
- 'data' -> section: 'Project Data'
- 'docs' -> section: 'Documentation'
- 'feat' -> section: 'Enhancements'
- 'fix' -> section: 'Bug Fixes'
- 'perf' -> section: 'Performance Improvements'
- 'revert' -> section: 'Reverts'
- 'docs' -> section: 'Documentation', hidden: true
- 'style' -> section: 'Styles', hidden: true
- 'chore' -> section: 'Miscellaneous Chores', hidden: true
- 'refactor' -> section: 'Code Refactoring', hidden: true
- 'test' -> section: 'Tests', hidden: true
- 'build' -> section: 'Build System', hidden: true
- 'ci' -> section: 'Continuous Integration', hidden: true
- 'refactor' -> section: 'Maintenances'
- 'test' -> section: 'Tests'
- 'style' -> section: 'Styles'

## 1 Usage

Expand Down
1 change: 0 additions & 1 deletion release-please-config.json

This file was deleted.

0 comments on commit 704a44b

Please sign in to comment.