... | ... | @@ -21,6 +21,19 @@ TODO: add more details about this. |
|
|
|
|
|
It should be clear what the PR is changing (link to an issue, explanation, small OpenAPI Spec to reproduce the issue).
|
|
|
|
|
|
Try to have a title that summarize the change. Remember that the PR titles are used in the release notes, so it is important to invest some effort. Good titles:
|
|
|
|
|
|
* Include the generator name, or the domain in brackets `[JAXRS-spec]`, `[JAVA][Rest-assured]`, `[C++][Restbed]`, `[docs]`, `[CI]`...
|
|
|
* Include a short summary of the change
|
|
|
|
|
|
The description is also an important aspect of the PR. It should provide more information about what the change brings:
|
|
|
|
|
|
* If the change introduce a new option, explain the possible values and what is the default
|
|
|
* If an issue exists that describes the problem, add a link to it.
|
|
|
* ...
|
|
|
|
|
|
Remember that the PR description will be the first place where developer look when they want to understand the intention behind a change.
|
|
|
|
|
|
Unit tests are always great.
|
|
|
|
|
|
Test locally if needed.
|
... | ... | |