Browse Source
Added PULL_REQUEST_TEMPLATE.md. Change ISSUE_TEMPLATE to BUG_REPORT_TEMPLATE.md. Minor refactoring to some files - spelling and grammar. Changes to BUG_REPORT_TEMPLATE to seperate meaning from PULL_REQUEST. The title ISSUE_TEMPLE could still apply to PULL_REQEST. They are in a good position for linking to the CONTRIBUTING.md file now.merge-requests/1/head
Craig Oates
7 years ago
5 changed files with 72 additions and 10 deletions
@ -0,0 +1,37 @@
|
||||
# Console.Waterworks - Bug Report |
||||
|
||||
## Prerequisites |
||||
|
||||
Before submitting, please make sure your issue has not already been filed. You can do this at [GitHub Issues](https://github.com/craigoates/issues "GitHub Issues"). |
||||
|
||||
## Description |
||||
|
||||
[Description of the issue. Use images and GIFs if necessary.] |
||||
|
||||
## Steps to Reproduce |
||||
|
||||
[Use images and GIFs if necessary.] |
||||
|
||||
1. [First Step] |
||||
1. [Second Step] |
||||
1. [and so on...] |
||||
|
||||
## Expected Behaviour |
||||
|
||||
[What you expect to happen] |
||||
|
||||
## Actual Behaviour |
||||
|
||||
[What actually happens] |
||||
|
||||
## Reproduction Rate |
||||
|
||||
[What percentage of the time does it happen?] |
||||
|
||||
## Versions |
||||
|
||||
[You can get this information from using the Nuget Package Manager tools in Visual Studio/Project References.] |
||||
|
||||
## Additional Information |
||||
|
||||
[Any additional information, configuration or data that might be necessary to reproduce the issue.] |
@ -1 +1,25 @@
|
||||
# Pull Request Templete - Incomplete |
||||
# Console.Waterworks - Pull Request |
||||
|
||||
## Requirements |
||||
|
||||
Filling out the template is required. Any pull request which does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion. |
||||
|
||||
## Description of the Change |
||||
|
||||
[TO DELETE] Aim to be as clear and concise as possible here. Use illustrations and gifs if you believe it will help explain your point. |
||||
|
||||
## Significant Design Changes |
||||
|
||||
[TO DELETE] If your pull request alters the design of the code in a significant manner, please state here what the changes are. If the changes are minor, feel free you include them in the description above. Do statement there is no major changes, though, for clarity. |
||||
|
||||
## Benefits |
||||
|
||||
[TO DELETE] List out the benefits. Aim to keep them short and to the point. |
||||
|
||||
## Possible (Immediate) Drawbacks |
||||
|
||||
[TO DELETE] List out any drawbacks your pull request introduces to the project. If you feel is necessary, elaborate as much as you can to help explain the drawbacks with accepting the pull request. |
||||
|
||||
## Foreseen Issues |
||||
|
||||
[TO DELETE] If you can foresee a problem **beyond** this pull request, use this section to highlight them. This will help determine the steps beyond the pull request, if any need to be taken. |
Loading…
Reference in new issue