Skip to content

Commit ca3fa4b

Browse files
authored
[contrib][docs] Assert importance of title/description/repro steps (#7103)
1 parent 34f0d02 commit ca3fa4b

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,13 @@ please create a Gist (https://gist.github.com) or upload it somewhere else and
4545
link it here.
4646
-->
4747

48-
##### Command line used for generation
48+
##### Generation Details
4949

50-
<!-- including the language, libraries and various options -->
50+
<!--
51+
Prefer CLI steps, including the language, libraries and various options.
52+
Providing config-based settings allows for simpler testing across CLI and plugins.
53+
For examples, see https://github.com/OpenAPITools/openapi-generator/tree/master/bin/configs
54+
-->
5155

5256
##### Steps to reproduce
5357

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
<!-- Please check the completed items below -->
44
### PR checklist
5-
5+
66
- [ ] Read the [contribution guidelines](https://github.com/openapitools/openapi-generator/blob/master/CONTRIBUTING.md).
7+
- [ ] 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.
78
- [ ] 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.
89
- [ ] 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/).
910
- [ ] File the PR against the [correct branch](https://github.com/OpenAPITools/openapi-generator/wiki/Git-Branches): `master`

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
- If you're not using the latest master to generate API clients or server stubs, please give it another try by pulling the latest master as the issue may have already been addressed. Ref: [Getting Started](https://github.com/openapitools/openapi-generator#getting-started)
66
- Search the [open issue](https://github.com/openapitools/openapi-generator/issues) and [closed issue](https://github.com/openapitools/openapi-generator/issues?q=is%3Aissue+is%3Aclosed) to ensure no one else has reported something similar before.
7-
- File an [issue ticket](https://github.com/openapitools/openapi-generator/issues/new) by providing all the required information.
7+
- File an [issue ticket](https://github.com/openapitools/openapi-generator/issues/new) by providing all the required information. Failure to provide enough detail may result in slow response from the community.
88
- Test with the latest master by building the JAR locally to see if the issue has already been addressed.
99
- You can also make a suggestion or ask a question by opening an "issue".
1010

0 commit comments

Comments
 (0)