Update PULL_REQUEST_TEMPLATE.md #4080
Conversation
* Updates the PR template to allow cleaner PR description workflow. * Cleans up some of the language/descriptions in check items. When a single commit PR is opened, GitHub will insert the commit message to the top of the PR template. Users who follow this flow previously needed to move this text to the bottom of the PR text, and remove the placeholder text. It's such common practice for github contributors to enter descriptions in PRs, we can omit the `Description` placeholder and be less prescriptive about where the description exists.
|
See the unmodified description of this PR's single-commit contribution for an example of what will be resolved by this commit. |
| <!-- Enter details of the change here. Include additional tests that have been done, reference to the issue for tracking, etc. --> | ||
|
|
||
| <!-- Please check the completed items below --> |
There was a problem hiding this comment.
This HTML comments won't be rendered in the final PR description.
| (details of the change, additional tests that have been done, reference to the issue for tracking, etc) | ||
|
|
||
| - [ ] 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) before . | ||
| - [ ] Run the shell script(s) under `./bin/` (or Windows batch scripts under`.\bin\windows`) to update Petstore samples related to your fix. This is important, as CI jobs will verify _all_ generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run `./bin/{LANG}-petstore.sh`, `./bin/openapi3/{LANG}-petstore.sh` if updating the code or mustache templates for a language (`{LANG}`) (e.g. php, ruby, python, etc). |
There was a problem hiding this comment.
e.g. for typescript-fetch one should only run bin/typescript-fetch-petstore-all.sh, not bin/openapi3/typescript-fetch-petstore-all.sh
There was a problem hiding this comment.
If users aren't expected to run the openapi3 script, why does it exist? Does it hurt anything if they do run it?
There was a problem hiding this comment.
If users aren't expected to run the openapi3 script, why does it exist?
I don't know, probably for testing purposes?
Does it hurt anything if they do run it?
yes, the body parameter changes its name and some extra inline-files are generated, leading to a failing ensure-samples-up-to-date.sh
There was a problem hiding this comment.
So, they're generating to the same directories? I think that's an issue if the 2.0 and 3.x outputs aren't the same.
I don't think this warrants an exception in the PR template. We should create an issue to investigate and fix for output parity. That, or generate to separate directories.
* master: (78 commits) Replaced dashes with underscores in build.gradle files. (#4092) [cxf-cdi] use @FormParam for form parameters when it is not Multipart (#4125) Corrections to script names (#4135) [python] Add missing keywords python (#4134) Update PULL_REQUEST_TEMPLATE.md (#4080) revert the fix to broken links Rename property name from propertyRawName to propertyBaseName (#4124) [Go] Fix go.mod and go.sum for 1.13 (#4084) [kotlin] add option for non public api (#4089) Added new discriminator RawName property to preserve declared discriminator for @JsonTypeInfo annotations (#3320) Fix links to other files (#4120) [JAVA][JAXRS] Fix parameters validation (#3862) Make Resttemplate thread safe by using the withHttpInfo pattern used by many other generated clients (#4049) Disabling linting for typescript-fetch (#4110) [Kotlin][Client] fix missing curly bracket when the model contains enum property (#4118) Fix NPE in Elm path parameter (#4116) test aiohttp first (#4117) add back ruby client folders update petstore samples [CLI] Initial implementation for batch generation (#3789) ...
When a single commit PR is opened, GitHub will insert the commit message to the top of the PR template. Users who follow this flow previously needed to move this text to the bottom of the PR text, and remove the placeholder text. It's such common practice for github contributors to enter descriptions in PRs, we can omit the
Descriptionplaceholder and be less prescriptive about where the description exists.PR checklist
./bin/to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.sh,./bin/openapi3/{LANG}-petstore.shif updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.master,4.1.x,5.0.x. Default:master.Description of the PR
(details of the change, additional tests that have been done, reference to the issue for tracking, etc)