github: mention the guides in the pull request template
The template mentioned only "adequate" documentation which can be interpreted in many ways. Mention the news/unreleased directory and the guides explicitly and include links for convenience.
This commit is contained in:
parent
f977a3703b
commit
6ed4c59010
1 changed files with 3 additions and 1 deletions
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -2,7 +2,9 @@
|
||||||
This pull request includes:
|
This pull request includes:
|
||||||
|
|
||||||
- [ ] adequate testing for the new functionality or fixed issue
|
- [ ] adequate testing for the new functionality or fixed issue
|
||||||
- [ ] adequate documentation informing people about the change
|
- [ ] adequate documentation informing people about the change such as
|
||||||
|
- [ ] create a file in [news/unreleased](https://github.com/osbuild/osbuild-composer/tree/main/docs/news/unreleased) directory if this change should be mentioned in the release news
|
||||||
|
- [ ] submit a PR for the [guides](https://github.com/osbuild/guides) repository if this PR changed any behavior described there: https://www.osbuild.org/guides/
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Thanks for proposing a change to osbuild-composer!
|
Thanks for proposing a change to osbuild-composer!
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue