From b1dbb846a07eb9335c2bb861b3a83d14a3286269 Mon Sep 17 00:00:00 2001 From: LZRS <12814349+LZRS@users.noreply.github.com> Date: Tue, 22 Feb 2022 12:01:58 +0300 Subject: [PATCH] Add github templates for standardized documentation --- .github/ISSUE_TEMPLATE/bug_report.md | 37 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/code_health.md | 11 +++++++ .github/ISSUE_TEMPLATE/enhancement.md | 15 +++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 21 +++++++++++++ .github/ISSUE_TEMPLATE/help_wanted.md | 11 +++++++ .github/ISSUE_TEMPLATE/process.md | 11 +++++++ .github/ISSUE_TEMPLATE/research.md | 18 +++++++++++ .github/pull_request_template.md | 16 ++++++++++ 8 files changed, 140 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/code_health.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/help_wanted.md create mode 100644 .github/ISSUE_TEMPLATE/process.md create mode 100644 .github/ISSUE_TEMPLATE/research.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..6269f5a34a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: 'bug' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Flavor** +Boresha Afya, Chad, Drc, Guinea, Togo, Liberia or LMH + +**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. + +**Smartphone (please complete the following information):** + - Device: [e.g. Samsung Galaxy A2 emulator] + - Android version: [e.g. Settings -> About phone -> Android version] + - Build number: [e.g. Settings -> About phone -> Build number] + - Version [e.g. 24] + +**Additional context** +Add any other context about the problem here. + diff --git a/.github/ISSUE_TEMPLATE/code_health.md b/.github/ISSUE_TEMPLATE/code_health.md new file mode 100644 index 0000000000..c26478e30a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/code_health.md @@ -0,0 +1,11 @@ +--- +name: Code health +about: Code refactoring, testing infrastructure, documentation, etc. +title: '' +labels: 'code health' +assignees: '' + +--- + +**Describe the Issue** + diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 0000000000..f565c3768b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,15 @@ +--- +name: Enhancement +about: Enhancement to existing feature +title: '' +labels: 'enhancement' +assignees: '' + +--- + +**Name of feature to enhance** + +**Description of feature** + +**Describe the enhancement** + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..ecb25dc097 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,21 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +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/ISSUE_TEMPLATE/help_wanted.md b/.github/ISSUE_TEMPLATE/help_wanted.md new file mode 100644 index 0000000000..677e13e124 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/help_wanted.md @@ -0,0 +1,11 @@ +--- +name: Help Wanted +about: Request for help. +title: '' +labels: 'help wanted' +assignees: '' + +--- + +**Describe the Issue** + diff --git a/.github/ISSUE_TEMPLATE/process.md b/.github/ISSUE_TEMPLATE/process.md new file mode 100644 index 0000000000..ca84b3cd2b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/process.md @@ -0,0 +1,11 @@ +--- +name: Process +about: Builds, releases, communications, etc. +title: '' +labels: 'process' +assignees: '' + +--- + +**Describe the Issue** + diff --git a/.github/ISSUE_TEMPLATE/research.md b/.github/ISSUE_TEMPLATE/research.md new file mode 100644 index 0000000000..dd4f3b7474 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/research.md @@ -0,0 +1,18 @@ +--- +name: Research +about: Research tasks +title: '' +labels: 'research' +assignees: '' + +--- + +**Describe the issue to be researched** +Include any background information and available resources. + +**Describe the goal of the research** +What's the desired outcome of this task? What artifacts should be produced? + +**Describe the methodology** +Where can more information be found? Who should the assignee approach to ask questions? How can a decision be made? + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..d71dbe75c8 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,16 @@ +**IMPORTANT: Where possible all PRs must be linked to a Github issue** + +Fixes #[issue number] + +**Description** +Clear and concise code change description. + +**Type** +Choose one: (Bug fix | Feature | Documentation | Testing | Code health | Release | Other) + +**Screenshots (if applicable)** + +**Checklist** +- [ ] I have written **Unit tests** for any new feature(s) and edge cases for bug fixes +- [ ] I have added any strings visible on UI components to the `strings.xml` file +- [ ] I have built and run the app to verify my change fixes the issue and/or does not break the app