From 6705e2be931c19b61d11d6659d68d835a99c124b Mon Sep 17 00:00:00 2001 From: Luca Date: Thu, 1 Oct 2020 19:13:57 +0200 Subject: [PATCH] Added templates for issues and pull requests --- .github/ISSUE_TEMPLATE/bug_report.md | 36 +++++++++++++++++++ .github/ISSUE_TEMPLATE/discussion.md | 22 ++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 26 ++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 22 ++++++++++++ .github/PULL_REQUEST_TEMPLATE/bug_fix.md | 32 +++++++++++++++++ .../feature_implementation.md | 32 +++++++++++++++++ 6 files changed, 170 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/discussion.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/bug_fix.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/feature_implementation.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..d5ac605f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,36 @@ +--- +name: Bug report +about: Create a report to help us improve the application +title: '' +labels: bug +assignees: '' + +--- + +**Important note** +Please check other open and closed issues for a similar bug before reporting a new one. + +**Behavior of the program** +Please write a clear and concise description of what the bug is. + +**Expected behavior** +Please describe clear and concise what you expected to happen. + +**To Reproduce** +Please add all steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Screenshots** +If applicable, please add screenshots to help explain your problem. Especially console logs from the development tools are very helpful. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - OS Version: [e.g. 22] + - FreeTube version: [e.g. 0.8] + + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/discussion.md b/.github/ISSUE_TEMPLATE/discussion.md new file mode 100644 index 00000000..2094b2e8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/discussion.md @@ -0,0 +1,22 @@ +--- +name: Discussion +about: Open up a new discussion about anything related to the project. +title: '' +labels: Discussion +assignees: '' + +--- + +**Important note** +Please check other open and closed issues for a similar discussion or a question relating to your discussion before posting a new one. + +**Topic** +Please select what topic your discussion is about. +- [ ] Coding +- [ ] Contribution +- [ ] Languages +- [ ] Setup +- [ ] Other. Please specify: + +**Discussion** +Please write down whatever you want to discuss. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..6a2c2b01 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,26 @@ +--- +name: Feature request +about: Suggest an idea for this project which you would like to see in a future release +title: '' +labels: enhancement +assignees: '' + +--- + +**Important note** +Please check other open and closed issues for a similar feature request before proposing a new one. + +**Is your feature request related to a usage problem (not a bug)? Please describe.** +Please describe clear and concise of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like to see implemented** +Please give a clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +Are there other ways to solve the problem? Please give a clear and concise description of any alternative solutions or features you might have considered. + +**Screenshots** +Sometimes people have screenshots from mock-ups or other projects. Add them here. + +**Additional context** +Add any other context about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..4bd43b1c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,22 @@ +--- +name: Question +about: Ask a question which is not a bug or a feature request +title: '' +labels: question +assignees: '' + +--- + +**Important note** +Please check other open and closed issues for a similar question before posting a new one. + +**Topic** +Please select what topic you are referring to. +- [ ] Coding +- [ ] Contribution +- [ ] Languages +- [ ] Setup +- [ ] Other. Please specify: + +**Question** +Please write down your question. diff --git a/.github/PULL_REQUEST_TEMPLATE/bug_fix.md b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md new file mode 100644 index 00000000..44f46925 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md @@ -0,0 +1,32 @@ +--- +name: Bugfix +about: Thanks for the submission of a bugfix +title: '' +labels: bug +assignees: '' + +--- + +**Important note** +Please note that only PrestoN is able to merge Pull Requests into master. + +**Related issue** +Please link the issue your bugfix is referring to. + +**Description** +Please write a clear and concise description of what the bugfix does. + +**Screenshots (if appropriate)** +Please add before and after screenshots if there is a visible change. + +**Testing (for fixes that are not easily understandable)** +Has this bugfix been tested? +Please describe shortly how you tested it and whether there are any ramifications remaining. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - OS Version: [e.g. 22] + - FreeTube version: [e.g. 0.8] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/PULL_REQUEST_TEMPLATE/feature_implementation.md b/.github/PULL_REQUEST_TEMPLATE/feature_implementation.md new file mode 100644 index 00000000..e0240efc --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/feature_implementation.md @@ -0,0 +1,32 @@ +--- +name: Feature implementation +about: Thanks for the implementation of a new feature +title: '' +labels: enhancement +assignees: '' + +--- + +**Important note** +Please note that only PrestoN is able to merge Pull Requests into master. + +**Related issue** +Please link the issue your feature is referring to. + +**Description** +Please write a clear and concise description of what the implementation does. + +**Screenshots (if appropriate)** +Please add before and after screenshots if there is a visible change. + +**Testing** +Has this feature been tested? +Please describe shortly how you tested it and whether there are any ramifications remaining. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - OS Version: [e.g. 22] + - FreeTube version: [e.g. 0.8] + +**Additional context** +Add any other context about the problem here.