diff options
author | Harsh Shandilya <msfjarvis@gmail.com> | 2019-10-27 22:52:40 +0530 |
---|---|---|
committer | Harsh Shandilya <msfjarvis@gmail.com> | 2019-10-27 22:52:40 +0530 |
commit | 36c2518f90ab0907d9f8b414a3a4dc33c9ad4bd4 (patch) | |
tree | 6f4c51b22afeba1e41b5e34300d5760d579b5841 | |
parent | 5df7be10b5f30dce68a23eb55f1dae9edc0263c0 (diff) |
github: Add PR and issue templates
Signed-off-by: Harsh Shandilya <msfjarvis@gmail.com>
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 32 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 20 | ||||
-rw-r--r-- | .github/pull_request_template.md | 35 |
3 files changed, 87 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..435cbdcb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +assignees: '' + +--- + +**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. + +**Device information (please complete the following information):** + - Device: [e.g. Google Pixel 2] + - OS: [e.g. stock ROM Android version 9.0] + - App version [e.g. 3.1.0] + +**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 00000000..f4558654 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FEATURE]" +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. 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 00000000..38b0f06f --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,35 @@ +## :loudspeaker: Type of change +<!--- Put an `x` in the boxes that apply --> +- [ ] Bugfix +- [ ] New feature +- [ ] Enhancement +- [ ] Refactoring + + +## :scroll: Description +<!--- Describe your changes in detail --> + + +## :bulb: Motivation and Context +<!--- Why is this change required? What problem does it solve? --> +<!--- If it fixes an open issue, please link to the issue here. --> + + +## :green_heart: How did you test it? + + +## :pencil: Checklist +<!--- Put an `x` in the boxes that apply --> +- [ ] I ran `./gradlew spotlessApply` before submitting the PR +- [ ] I reviewed submitted code + + +## :crystal_ball: Next steps + + +## :camera_flash: Screenshots / GIFs +<!--- Mandatory for UI changes --> +<!-- Uncomment the next line and replace it with links to your screenshots. --> +<!-- +<img src="https://placekitten.com/260/260" width="260"> <img src="https://placekitten.com/300/300" width="260"> +--> |