Skip to content

Commit

Permalink
Improve documentation about default labels
Browse files Browse the repository at this point in the history
  • Loading branch information
lo1tuma committed Mar 9, 2018
1 parent 0c9232a commit 7d93d07
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,18 @@ You have to follow these steps to use `pr-log` without problems.

### GitHub

The default categories for the changelog are set in `lib/validLabels.js`. The following categories are predefined (`<label name>: <human friendly name>`):

```
bug: 'Bug Fixes',
upgrade: 'Dependency Upgrades',
documentation: 'Documentation',
feature: 'Features',
enhancement: 'Enhancements',
build: 'Build-Related',
breaking: 'Breaking Changes',
refactor: 'Code Refactoring'
```
The following categories are defined by default:

| GitHub label | Human friendly name | Description |
| -------------:|:------------- | ------ |
| `bug` | Bug Fixes | Changes that only fix a bug |
| `upgrade` | Dependency Upgrades | Any kind of dependency updates |
| `documentation` | Documentation | Changes to documentation and/or README |
| `feature` | Features | New features |
| `enhancement` | Enhancements | Non-breaking improvements of existing features |
| `build` | Build-Related | Changes related to the build process and/or CI/CD pipeline |
| `breaking` | Breaking Changes | Backwards-incompatible changes |
| `refactor` | Code Refactoring | Changes that don’t affect the behavior but improve the code quality |

However, you can also create a custom mapping by adding a `pr-log.validLabels` section to your `package.json`. For example:

Expand Down

0 comments on commit 7d93d07

Please sign in to comment.