Skip to content

Commit

Permalink
Configure release please to pickup extra commit types
Browse files Browse the repository at this point in the history
  • Loading branch information
kjnsn committed Oct 25, 2024
1 parent 5e273e4 commit aa2fa3a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
7 changes: 5 additions & 2 deletions .github/release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,11 @@
}
},
"changelog-sections": [
{ "type": "feat", "section": "Features" },
{ "type": "fix", "section": "Bug Fixes" },
{ "type": "feat", "section": "Added" },
{ "type": "change", "section": "Changed" },
{ "type": "fix", "section": "Fixed" },
{ "type": "deprecate", "section": "Deprecated" },
{ "type": "remove", "section": "Removed" },
{ "type": "perf", "section": "Performance Improvements" },
{ "type": "revert", "section": "Reverts" },
{ "type": "docs", "section": "Documentation" }
Expand Down
14 changes: 6 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

## Design

To understand our mindset in developing this plugin and how to ensure your changes align with that mindset, check out the "[Design Philosophy](./docs/explanation/design.md)."
To understand our mindset in developing this plugin and how to ensure your
changes align with that mindset, check out the "[Design Philosophy](./docs/explanation/design.md)."

## Commit messages

Expand All @@ -13,21 +14,18 @@ describes the motivation and content of the commit.
### Commit types

- `fix`: A bug fix that doesn't modify the public API
- `feat`: A code change that modifies the public API
- `feat`: A code change that adds functionality
- `change`: A modification to the public API
- `deprecate`: Something in the public API has been deprecated
- `remove`: A part of the public API has been removed
- `refactor`: A code change that doesn't change behavior
- `style`: A style fix or change
- `docs`: Any change to documentation
- `ci`: Any change to CI files
- `revert`: A revert commit. The message should describe the reasoning and the
commit should include the `Refs:` footer with the short hashes of the commits
being reverted.
- `chore`: catch-all type

### Commit scopes

Available commit scopes are module names, `status`, `pane`, and
`window`. If none of these apply, omit the scope.

### Breaking changes

All breaking changes should be documented in the commit footer in the format
Expand Down

0 comments on commit aa2fa3a

Please sign in to comment.