From 234e6dbbc855809190932f0d0850e0e4e6df2b19 Mon Sep 17 00:00:00 2001 From: Thomas Bruyelle Date: Thu, 5 Mar 2020 10:48:15 +0100 Subject: [PATCH] Add 'Issue template' and 'Bug report template' (#314) Add 'bug report' and 'feature' templates. From now users who want to open a new issue will be asked to fill down some template in order to give a comprehensive information about some bug or other code defect. Also, user will be asked first to chose one of 2 options - create a Bug report - crete a Feature request fixes --- .github/ISSUE_TEMPLATE/bug_report.md | 45 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++ 2 files changed, 65 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..4d5c17a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,45 @@ +--- +name: Bug report +about: 'Create a bug report. ' +title: Bug +labels: '' +assignees: '' + +--- + +### Prerequisites + +* [] Put an X between the brackets on this line if you have done all of the following: + * Read carefully README: https://github.com/tbruyelle/RxPermissions#rxpermissions + * Checked that your issue isn't already filed: https://github.com/tbruyelle/RxPermissions/issues + +### Issue description +[A clear and concise description of what the bug is.] + +### Actual behavior +[A clear and concise description of what actually happened.] + +### Expected behavior +[A clear and concise description of what you expected to happen.] + +### Steps To Reproduce +Steps to reproduce the behavior: +1. [First Step] +2. [Second Step] +3. [and so on...] + +### RxPermission usage code **(extremely Required)** +Give a comprehensive example of how exactly RxPermission is used (Use [gists](https://gist.github.com/) or style code with styling markdown). +Provide all info from the beginning that includes: +- How and where RxPermission was instantiated. +- In what lifecycle method. Activity or fragment. Give info about screen view hierarchy if it really complicated and has many nested Fragments. +- Some additional info or important context if needed. + +### Lib Version +Give info about what lib version do you use + +**Screenshots** +Add screenshots to help explain your problem only If it will be handy for your use case. +If issued only with particular device provide device info + - Device: [e.g. Nexus 5] + - OS version: [Android 5.1] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..e10e0bb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea +title: '' +labels: '' +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.