Skip to content

Commit 9b2b6b9

Browse files
mdietzemdietze
authored
Merge pull request #21 from Sweetdevil144/main
Add ISSUES and PULL-REQUEST Templates
2 parents 931390f + a6cc29e commit 9b2b6b9

File tree

5 files changed

+128
-0
lines changed

5 files changed

+128
-0
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!--- Provide a general summary of the issue in the Title above -->
2+
<!--- Please select appropriate Priority, Status,and Type labels-->
3+
<!--- If you do not have permission to select labels please state which labels you would like -->
4+
## Description
5+
<!--- What change or feature do you propose? -->
6+
7+
## Context
8+
<!--- Why is this change important to you? How would you use it? -->
9+
<!--- How can it benefit other users and communities? -->
10+
<!--- Is there existing software with a similar featuer? -->
11+
12+
## Possible Implementation
13+
<!--- Not obligatory, but suggest an idea for implementing addition or change -->

‎.github/ISSUE_TEMPLATE/Bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
### Bug Description
8+
9+
A clear and concise description of what the bug is.
10+
11+
In the format "When I do X, I expect Y but observe Z"
12+
13+
### To Reproduce
14+
15+
Steps to reproduce the behavior:
16+
1. Go to '...'
17+
2. Click on '....'
18+
3. Scroll down to '....'
19+
4. See error
20+
21+
## Expected behavior
22+
23+
A clear and concise description of what you expected to happen.
24+
25+
## Screenshots
26+
27+
If applicable, add screenshots to help explain your problem.
28+
29+
## Machine (please complete the following information):
30+
31+
- Server [e.g. BU, NCSA, VM, etc.]
32+
- OS: [e.g.Linux]
33+
- Browser(if applicable) [e.g. chrome, safari]
34+
- Version [e.g. 22]
35+
36+
## Additional context
37+
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/Doc_changes.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Documentation Changes
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
### Document Change needed
8+
9+
A clear description of what changes are needed with the location of the error, or that needs to be fixed.
10+
11+
Example:
12+
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/.
13+
14+
### Information for those wanting to make changes
15+
16+
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.
17+
18+
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`.

‎.github/ISSUE_TEMPLATE/Feature_request.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
## Description
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
## Proposed Solution
13+
14+
**Describe the solution you'd like**
15+
A clear and concise description of what you want to happen.
16+
17+
## Alternatives Considered
18+
19+
**Describe alternatives you've considered**
20+
A clear and concise description of any alternative solutions or features you've considered.
21+
22+
## Additional Context
23+
24+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
<!--- Please select appropriate Priority, Status,and Type labels-->
3+
<!--- If you do not have permission to select labels please state which labels you would like -->
4+
5+
## Description
6+
<!--- Describe your changes in detail -->
7+
8+
## Motivation and Context
9+
<!--- Why is this change required? What problem does it solve? -->
10+
<!--- If it fixes an open issue, please link to the issue here. -->
11+
12+
## Review Time Estimate
13+
<!---When do you want your code reviewed by?-->
14+
- [ ] Immediately
15+
- [ ] Within one week
16+
- [ ] When possible
17+
18+
## Types of changes
19+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
20+
- [ ] Bug fix (non-breaking change which fixes an issue) <!-- please add issue number -->
21+
- [ ] New feature (non-breaking change which adds functionality)
22+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
23+
24+
## Checklist:
25+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
26+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
27+
- [ ] My change requires a change to the documentation.
28+
- [ ] My name is in the list of CITATION.cff
29+
- [ ] I have updated the CHANGELOG.md.
30+
- [ ] I have updated the documentation accordingly.
31+
- [ ] I have read the **CONTRIBUTING** document.
32+
- [ ] I have added tests to cover my changes.
33+
- [ ] All new and existing tests passed.
34+
35+
<!--this template is from https://www.talater.com/open-source-templates/#/page/99-->

0 commit comments

Comments
 (0)