mirror of
https://github.com/interviewstreet/go-jira.git
synced 2024-11-24 08:22:42 +02:00
6ad1917706
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.
1.2 KiB
1.2 KiB
Description
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.
// Example code
Checklist
- Unit or Integration tests added
- Good Path
- Error Path
- Commits follow conventions described here:
- 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.