mirror of
https://github.com/interviewstreet/go-jira.git
synced 2025-02-03 13:11:49 +02:00
improvement: Request more information in a pull request template
Makes the Pull Request template a bit more explicit. Goals of this are: - to guide the user more - to make it more clear what we are asking for (e.g. what kind of tests) - to ask for code examples (that could be used for documentation) - to start a thought process for the contributor - to make the maintainers work a bit easier Addiotionally we formatted the links in the checklist a bit more readable for a human.
This commit is contained in:
parent
10b99828bc
commit
6ad1917706
27
.github/PULL_REQUEST_TEMPLATE.md
vendored
27
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user