Update PR Template to help autoclose issues. #457
Conversation
| Use format: | ||
| Fixes #123 | ||
| Fixes #124 | ||
| --> |
| @@ -6,3 +6,15 @@ Thank you for contributing to this project! | |||
| - Our vulnerabilities reporting process is at https://voxpupuli.org/security/ | |||
|
|
|||
| --> | |||
| #### Pull Request (PR) description | |||
There was a problem hiding this comment.
I feel like this is redundant and would leave it out.
There was a problem hiding this comment.
I felt it would be consistent to put it there if the issue to be closed was going to be added. Also was not sure if users would sometimes put the PR description about the issues section or below it. I can remove it though if you feel strongly about this.
| Replace this comment with a description of your pull request. | ||
| --> | ||
|
|
||
| #### This Pull Request (PR) fixes the following issues |
There was a problem hiding this comment.
should we clarify that it isn't required to have an open issue for a PR? Also a PR can implement a new feature.
There was a problem hiding this comment.
On line 16 there is a comment indicating put N/A if no issues apply.
In regards to the feature thing it really depends on how we define an issue and how we purpose it as a team. Based on my exposure to other communities and also reading information provided by github ( https://help.github.com/articles/about-issues/ ) issues are typically used for more than just bugs/problems. They are a great way to:
- Ask Questions if you are a user. There isn't a forum for github repos unless you expose one for the users in the readme.md that is easily findable
- Discuss features
- Discuss ideas
- Report problems
Essentially anything someone wants to make the repository maintainers aware of :). Also you cannot really prevent people from not using it for more than bugs :P.
|
Thanks for the input! |
This change adds 2 key pieces of information to the PR template.