diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 26ee785..4a3bf0d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,32 @@ -# PR Description +# Description -_What does this fix or add?_ +Please describe _what does this Pull Request fix or add?_. + +Information that is useful here: +* **The What**: What is your change doing? +* **The Why**: Why is your change useful/needed? What is your use case? (this helps us to understand the real world better) +* **Type of change**: Things like Bugfix, New feature, Code quality improvements, Dependency upgrade, Documentation, ... +* **Breaking change**: Yes or no? Backward compatible? +* **Related to an issue**: Does this fix or close an issue? Or is related in any kind? +* **Jira Version + Type**: Which Jira version and type (on-premise / cloud) you have used? + +## Example: + +Let us know how users can use or test this functionality. + +```go +// Example code + +``` # Checklist -* [ ] Tests added +* [ ] Unit or Integration tests added * [ ] Good Path * [ ] Error Path * [ ] Commits follow conventions described here: - * [ ] [https://conventionalcommits.org/en/v1.0.0-beta.4/#summary](https://conventionalcommits.org/en/v1.0.0-beta.4/#summary) - * [ ] [https://chris.beams.io/posts/git-commit/#seven-rules](https://chris.beams.io/posts/git-commit/#seven-rules) + * [ ] [Conventional Commits 1.0.0](https://conventionalcommits.org/en/v1.0.0-beta.4/#summary) + * [ ] [The seven rules of a great Git commit message](https://chris.beams.io/posts/git-commit/#seven-rules) * [ ] Commits are squashed such that * [ ] There is 1 commit per isolated change * [ ] I've not made extraneous commits/changes that are unrelated to my change.