From f136b9fd01289e116a75f585b85ee92aa7356b7c Mon Sep 17 00:00:00 2001 From: Esteban Gehring Date: Sun, 10 Jan 2021 07:46:31 +0100 Subject: [PATCH] docs: improve pull request checklist (#8349) * docs: improve pull request checklist include build command before updating samples * Update PULL_REQUEST_TEMPLATE.md * Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 634ba51b9bd..7f2e3d8d432 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,6 +6,17 @@ - [ ] Read the [contribution guidelines](https://github.com/openapitools/openapi-generator/blob/master/CONTRIBUTING.md). - [ ] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community. - [ ] If contributing template-only or documentation-only changes which will change sample output, [build the project](https://github.com/OpenAPITools/openapi-generator#14---build-projects) beforehand. -- [ ] Run the shell script `./bin/generate-samples.sh`to update all Petstore samples related to your fix. This is important, as CI jobs will verify _all_ generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example `./bin/generate-samples.sh bin/configs/java*`. For Windows users, please run the script in [Git BASH](https://gitforwindows.org/). +- [ ] Run + ``` + mvn clean package + ./bin/generate-samples.sh + ./bin/utils/export_docs_generators.sh + ``` + to update all Petstore samples related to your fix. + Commit all changed files. + This is important, as CI jobs will verify _all_ generator outputs of your HEAD commit as it would merge with master. + These must match the expectations made by your contribution. + You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example `./bin/generate-samples.sh bin/configs/java*`. + For Windows users, please run the script in [Git BASH](https://gitforwindows.org/). - [ ] File the PR against the [correct branch](https://github.com/OpenAPITools/openapi-generator/wiki/Git-Branches): `master`, `5.1.x`, `6.0.x` - [ ] Copy the [technical committee](https://github.com/openapitools/openapi-generator/#62---openapi-generator-technical-committee) to review the pull request if your PR is targeting a particular programming language.