Skip to content

Commit d68d28e

Browse files
authored
Add templates for PR and Issues (#861)
* Add templates for PR and Issues * remove .github folder from testing coverage * add specific templates to ignore codecov testing
1 parent 5cfa964 commit d68d28e

File tree

5 files changed

+60
-0
lines changed

5 files changed

+60
-0
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug report
3+
about: Report a bug in GMSO
4+
5+
---
6+
7+
**Bug summary**
8+
9+
What were you trying to do and what happened instead? Please copy and paste the stack output
10+
11+
12+
**Code to reproduce the behavior**
13+
14+
Please include a code snippet that can be used to reproduce this bug.
15+
16+
```python
17+
# Paste your code here
18+
#
19+
#
20+
```
21+
22+
**Software versions**
23+
24+
- Which version of GMSO are you using? (`python -c "import gmso; print(gmso.__version__)"`)
25+
- Which version of Python (`python --version`)?
26+
- Which operating system?
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an improvement to GMSO
4+
5+
---
6+
7+
**Describe the behavior you would like added to GMSO**
8+
A clear and concise description of what the proposed idea is.
9+
10+
**Describe the solution you'd like**
11+
A clear and concise description of what you want to happen.
12+
13+
**Describe alternatives you've considered**
14+
A clear and concise description of any alternative solutions or features you've considered.
15+
16+
**Additional context**
17+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/QUESTION.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Questions/discussions
3+
about: For usage questions, important notes, and other discussions.
4+
5+
---
6+
7+
**A summary of the question or discussion topic.**

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
### PR Summary:
2+
3+
### PR Checklist
4+
------------
5+
- [ ] Includes appropriate unit test(s)
6+
- [ ] Appropriate docstring(s) are added/updated
7+
- [ ] Code is (approximately) PEP8 compliant
8+
- [ ] Issue(s) raised/addressed?

codecov.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,5 @@ ignore:
44
- "gmso/paper"
55
- "gmso/formats/networkx.py"
66
- "gmso/external/convert_foyer_xml.py"
7+
- "gmso/.github/ISSUE_TEMPLATE"
8+
- "gmso/.github/PULL_REQUEST_TEMPLATE.md"

0 commit comments

Comments
 (0)