Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add github templates for standardized documentation #2009

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.

11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/code_health.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Code health
about: Code refactoring, testing infrastructure, documentation, etc.
title: ''
labels: 'code health'
assignees: ''

---

**Describe the Issue**

15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -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**

21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.

11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/help_wanted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Help Wanted
about: Request for help.
title: ''
labels: 'help wanted'
assignees: ''

---

**Describe the Issue**

11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/process.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Process
about: Builds, releases, communications, etc.
title: ''
labels: 'process'
assignees: ''

---

**Describe the Issue**

18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/research.md
Original file line number Diff line number Diff line change
@@ -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?

16 changes: 16 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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