diff options
author | M Somerville <dracos@users.noreply.github.com> | 2018-05-15 12:10:14 +0100 |
---|---|---|
committer | Matthew Somerville <matthew-github@dracos.co.uk> | 2018-09-28 16:02:41 +0100 |
commit | 6b1ff7d44d1b7533bf5037c0a9c1c5d8db4e1e0b (patch) | |
tree | 95406d31ffe678adba7eb404e6a12e823eca3ec0 | |
parent | 7149fb72f685d4950835d25c045ce96b13ef496f (diff) |
Add issue/PR templates.
-rw-r--r-- | .github/ISSUE_TEMPLATE/Bug_report.md | 40 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/Feature_request.md | 17 | ||||
-rw-r--r-- | .github/pull_request_template.md | 15 |
3 files changed, 72 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md new file mode 100644 index 000000000..1bf32922a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -0,0 +1,40 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +Note if the bug is about the mobile native app (not the website, whether that +is desktop or mobile), please leave it in the +[https://github.com/mysociety/fixmystreet-mobile/issues](fixmystreet-mobile +repository). + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. Windows] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md new file mode 100644 index 000000000..bc58e757a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is; e.g. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..e8a7c408e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,15 @@ +Please check the following: + +- [ ] Whether this PR should include changes to any documentation, or the FAQ; +- [ ] All cobrand-specific commits start their commit message with the cobrand in square brackets; +- [ ] Is new functionality tested? CodeCov will warn you about the diff coverage, but won’t complain about e.g. new files; +- [ ] Are the changes tested for accessibility? +- [ ] Have you updated the changelog? If this is not necessary, put square brackets around this: skip changelog + +Please check the contributing docs, and describe your pull request here. +Screenshots or GIF animations (using e.g. LICEcap) may be helpful. + +Please include any issues that are fixed, using "fixes" or "closes" so that +they are auto-closed when the PR is merged. + +Thanks for contributing! |