Skip to content

Commit

Permalink
Add templates for PR and Issues
Browse files Browse the repository at this point in the history
  • Loading branch information
CalCraven committed Nov 1, 2024
1 parent e656699 commit 0222f53
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Bug report
about: Report a bug in GMSO

---

**Bug summary**

What were you trying to do and what happened instead? Please copy and paste the stack output


**Code to reproduce the behavior**

Please include a code snippet that can be used to reproduce this bug.

```python
# Paste your code here
#
#
```

**Software versions**

- Which version of GMSO are you using? (`python -c "import gmso; print(gmso.__version__)"`)
- Which version of Python (`python --version`)?
- Which operating system?
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 improvement to GMSO

---

**Describe the behavior you would like added to GMSO**
A clear and concise description of what the proposed idea is.

**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.
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/QUESTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: Questions/discussions
about: For usage questions, important notes, and other discussions.

---

**A summary of the question or discussion topic.**
8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
### PR Summary:

### PR Checklist
------------
- [ ] Includes appropriate unit test(s)
- [ ] Appropriate docstring(s) are added/updated
- [ ] Code is (approximately) PEP8 compliant
- [ ] Issue(s) raised/addressed?

0 comments on commit 0222f53

Please sign in to comment.