go/go-jira
1
0
Fork 0
mirror of https://github.com/interviewstreet/go-jira.git synced 2025-06-08 23:26:20 +02:00
Code Issues Releases Activity

improvement: Request more information in a pull request template

Browse Source 
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:
Andy Grunwald 2020-04-29 08:50:44 +02:00 committed by Wes McNamee
parent 10b99828bc
commit 6ad1917706
1 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -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 # Checklist
* [ ] Tests added * [ ] Unit or Integration tests added
* [ ] Good Path * [ ] Good Path
* [ ] Error Path * [ ] Error Path
* [ ] Commits follow conventions described here: * [ ] 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) * [ ] [Conventional Commits 1.0.0](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) * [ ] [The seven rules of a great Git commit message](https://chris.beams.io/posts/git-commit/#seven-rules)
* [ ] Commits are squashed such that * [ ] Commits are squashed such that
* [ ] There is 1 commit per isolated change * [ ] There is 1 commit per isolated change
* [ ] I've not made extraneous commits/changes that are unrelated to my change. * [ ] I've not made extraneous commits/changes that are unrelated to my change.