Skip to content

Commit

Permalink
Merge pull request #985 from metno/issuetemplate971
Browse files Browse the repository at this point in the history
Introduce issue templates
  • Loading branch information
lewisblake committed Feb 2, 2024
2 parents 37d04bf + dbb86e7 commit 797d8c9
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
---

**Describe the bug**
Please provide a clear and concise description of what the bug is.
- Pyaerocom version:
- Computing platform:
- Configuration file (if applicable):
- Error message (if applicable):

**To Reproduce**
Steps to reproduce the behavior:
1.
2.
3.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Pyaerocom documentation
url: https://pyaerocom.readthedocs.io/en/latest/
about: Documentation page for Pyaerocom
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Documentation
about: Suggest changes in the documentation.
title: ''
labels: documentation

---

**Describe a problem and/or suggest an improvement**
- Something incorrect or unclear in the documentation?
- Something should be added to the documentation?
- Something should be removed from the documentation?
- Something should be re-structured in the documentation?
- Suggest a Q&A for the FAQ?

**Additional context**
Add any other context or screenshots about the feature request here.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is.

**Describe the solution you would like to see**
A clear and concise description of what you want to happen.
- Would you be able to work on this solution yourself?
- How can the Pyaerocom development team assist you?

**Additional context**
Add any other context or screenshots about the feature request here.
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/general_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: General issue
about: Used for general issues, not covered by other templates.
title: ''
labels: ''

---

0 comments on commit 797d8c9

Please sign in to comment.