1
0
Fork 0

add GitHub templates for PRs and releases

This commit adds:

1. a release template for GitHub releases.
2. a pull request template to help contributors and maintainers to understand and merge PRs faster, and label them correctly.

When using GitHub automated release notes, PRs will be split into sections based on the following labels:

- `breaking-change` or `config-change`
- `dependencies`
- `enhancement`
- `fix` or `bug`
- `plumbing`, `tests` or `deployment`
- all other PRs

Any labels not currently in use will be added once the PR for this commit is finalised and merged.
This commit is contained in:
Hugh Rundle 2024-04-28 13:30:47 +10:00
parent c4b21ee258
commit e4035c6da6
No known key found for this signature in database
GPG key ID: A7E35779918253F9
2 changed files with 104 additions and 0 deletions

26
.github/release.yml vendored Normal file
View file

@ -0,0 +1,26 @@
changelog:
exclude:
labels:
- ignore-for-release
categories:
- title: ‼️ Breaking Changes & New Settings ⚙️
labels:
- breaking-change
- config-change
- title: Updated Dependencies 🧸
labels:
- dependencies
- title: New Features 🎉
labels:
- enhancement
- title: Bug Fixes 🐛
labels:
- fix
- bug
- title: Internals/Plumbing 👩‍🔧
- plumbing
- tests
- deployment
- title: Other Changes
labels:
- "*"