From da2bbd2873e5bed4021b30cdb77c859445db3a39 Mon Sep 17 00:00:00 2001 From: Nicolas MASSART Date: Mon, 14 Dec 2020 10:13:21 +0100 Subject: [PATCH] update PR template Signed-off-by: Nicolas MASSART --- .github/pull_request_template.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 993bf8e7464..d1354b84626 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,9 +1,22 @@ -**Before pushing any commit in your pull request, make sure that:** +## Pull request checklist + +Use the following list to make sure your PR fits the Besu doc quality standard. + +### Before creating the pull request + +Make sure that: -- [ ] you read the [contribution guidelines](https://wiki.hyperledger.org/display/BESU/Contributing+to+documentation). - [ ] [all commits in this PR are signed off for the DCO](https://wiki.hyperledger.org/display/BESU/DCO). +- [ ] you read the [contribution guidelines](https://wiki.hyperledger.org/display/BESU/Contributing+to+documentation). - [ ] you have [tested your changes locally](https://wiki.hyperledger.org/display/BESU/MkDocs+And+Markdown+Guide#MkDocsAndMarkdownGuide-PreviewTheDocumentation) before submitting them to the community for review. -- [ ] you verified the rendering on [ReadTheDocs.org PR preview](https://wiki.hyperledger.org/display/BESU/MkDocs+And+Markdown+Guide#MkDocsAndMarkdownGuide-PreviewwithReadTheDocs) (see [Testing](#testing)) + +### After creating your pull request and tests finished + +Make sure that: + +- [ ] you fixed all the issues raised by the tests, if any. +- [ ] you verified the rendering of your changes on [ReadTheDocs.org PR preview](https://wiki.hyperledger.org/display/BESU/MkDocs+And+Markdown+Guide#MkDocsAndMarkdownGuide-PreviewwithReadTheDocs) + and updated the testing link (see [Testing](#testing)). ## Describe the change