From 6ed4c590101370ab52d1a9963480c2a20c2313bb Mon Sep 17 00:00:00 2001 From: Martin Sehnoutka Date: Thu, 1 Apr 2021 13:49:55 +0200 Subject: [PATCH] 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. --- .github/PULL_REQUEST_TEMPLATE.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e9449839a..75d0c59c8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,7 +2,9 @@ This pull request includes: - [ ] 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/