mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-11-23 02:06:29 -05:00
Introduce changelog snippets
To make life easier for the release manager, this introduces changelog snippets to the contribution docs and the PR template. Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
parent
a865ed0822
commit
b0db43ac15
2 changed files with 11 additions and 0 deletions
1
.github/pull_request_template.md
vendored
1
.github/pull_request_template.md
vendored
|
@ -11,6 +11,7 @@ This PR fixes/adds/improves/...
|
|||
- [ ] Added implementation
|
||||
- [ ] Added / updated tests
|
||||
- [ ] Added / updated documentation
|
||||
- [ ] Added changelog snippet
|
||||
- [ ] I read the [contribution documentation](https://github.com/hedgedoc/hedgedoc/blob/master/CONTRIBUTING.md) and signed-off my commits to accept the DCO.
|
||||
|
||||
### Related Issue(s)
|
||||
|
|
|
@ -51,6 +51,16 @@ If you set your `user.name` and `user.email` git configs, you can sign your comm
|
|||
You can also use git [aliases](https://git-scm.com/book/tr/v2/Git-Basics-Git-Aliases) like `git config --global alias.ci 'commit -s'`.
|
||||
Now you can commit with `git ci` and the commit will be signed.
|
||||
|
||||
## Changelog snippets
|
||||
|
||||
PRs that fix a bug or add a new feature or enhancement should add a corresponding changelog entry.
|
||||
The changelog can be found at `public/docs/release-notes.md`. If there is no section for the next release yet, just add
|
||||
one using `## <i class="fa fa-tag"></i> 1.x.x <i class="fa fa-calendar-o"></i> UNRELEASED`. The version and date will
|
||||
be filled later by the maintainers.
|
||||
Add a short description for your change in the `Features`, `Enhancements` or `Bugfixes` section, creating the section
|
||||
if needed. Have a look at previous entries for inspiration.
|
||||
You are welcome to add a `(by [@your_username](https://github.com/your_username))` note to your entry.
|
||||
|
||||
## Submitting a Pull Request
|
||||
|
||||
1. Submit an issue describing your proposed change.
|
||||
|
|
Loading…
Reference in a new issue