diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..bd2d2c5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,13 @@ + + + +## Description + + +## Context + + + + +## Possible Implementation + diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md new file mode 100644 index 0000000..6edc052 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +### Bug Description + +A clear and concise description of what the bug is. + +In the format "When I do X, I expect Y but observe Z" + +### 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. + +## Machine (please complete the following information): + + - Server [e.g. BU, NCSA, VM, etc.] + - OS: [e.g.Linux] + - Browser(if applicable) [e.g. chrome, safari] + - Version [e.g. 22] + +## Additional context + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/Doc_changes.md b/.github/ISSUE_TEMPLATE/Doc_changes.md new file mode 100644 index 0000000..5ca90ae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Doc_changes.md @@ -0,0 +1,18 @@ +--- +name: Documentation Changes +about: Create a report to help us improve + +--- + +### Document Change needed + +A clear description of what changes are needed with the location of the error, or that needs to be fixed. + +Example: +There is a broken URL link in the documentation. It is in the master version in section 13.2.1 on line 17. The underlying file is `/pecan/book_source/04_advanced_user_guide/01_R_workflow.Rmd`. The correct link should be https://aws.amazon.com/. + +### Information for those wanting to make changes + +Please follow the instructions in the [Editing this Book](https://pecanproject.github.io/pecan-documentation/develop/about-the-pecan-book.html#bookediting) section of the documentation. + +All R-markdown files related to documentation are located within the main directory `/pecan/book_source` except for the demos and vignettes which are in `pecan/documentation/tutorials`. diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md new file mode 100644 index 0000000..1ab93df --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -0,0 +1,24 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +## Description + +**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 [...] + +## Proposed Solution + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +## Alternatives Considered + +**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/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..1293b3e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,35 @@ + + + + +## Description + + +## Motivation and Context + + + +## Review Time Estimate + +- [ ] Immediately +- [ ] Within one week +- [ ] When possible + +## Types of changes + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist: + + +- [ ] My change requires a change to the documentation. +- [ ] My name is in the list of CITATION.cff +- [ ] I have updated the CHANGELOG.md. +- [ ] I have updated the documentation accordingly. +- [ ] I have read the **CONTRIBUTING** document. +- [ ] I have added tests to cover my changes. +- [ ] All new and existing tests passed. + +