diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md new file mode 100644 index 00000000..f197fed5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -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? diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md new file mode 100644 index 00000000..071df881 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/QUESTION.md b/.github/ISSUE_TEMPLATE/QUESTION.md new file mode 100644 index 00000000..2d2a393f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/QUESTION.md @@ -0,0 +1,7 @@ +--- +name: Questions/discussions +about: For usage questions, important notes, and other discussions. + +--- + +**A summary of the question or discussion topic.** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..ebc4b8b3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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? diff --git a/codecov.yml b/codecov.yml index e382bcec..3df236bf 100644 --- a/codecov.yml +++ b/codecov.yml @@ -4,3 +4,5 @@ ignore: - "gmso/paper" - "gmso/formats/networkx.py" - "gmso/external/convert_foyer_xml.py" + - "gmso/.github/ISSUE_TEMPLATE" + - "gmso/.github/PULL_REQUEST_TEMPLATE.md"