Skip to content

Commit

Permalink
Merge pull request PecanProject#21 from Sweetdevil144/main
Browse files Browse the repository at this point in the history
Add ISSUES and PULL-REQUEST Templates
  • Loading branch information
mdietze authored Mar 28, 2024
2 parents 931390f + a6cc29e commit 9b2b6b9
Show file tree
Hide file tree
Showing 5 changed files with 128 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!--- Provide a general summary of the issue in the Title above -->
<!--- Please select appropriate Priority, Status,and Type labels-->
<!--- If you do not have permission to select labels please state which labels you would like -->
## Description
<!--- What change or feature do you propose? -->

## Context
<!--- Why is this change important to you? How would you use it? -->
<!--- How can it benefit other users and communities? -->
<!--- Is there existing software with a similar featuer? -->

## Possible Implementation
<!--- Not obligatory, but suggest an idea for implementing addition or change -->
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/Doc_changes.md
Original file line number Diff line number Diff line change
@@ -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`.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
35 changes: 35 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!--- Provide a general summary of your changes in the Title above -->
<!--- Please select appropriate Priority, Status,and Type labels-->
<!--- If you do not have permission to select labels please state which labels you would like -->

## Description
<!--- Describe your changes in detail -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## Review Time Estimate
<!---When do you want your code reviewed by?-->
- [ ] Immediately
- [ ] Within one week
- [ ] When possible

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue) <!-- please add issue number -->
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] 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.

<!--this template is from https://www.talater.com/open-source-templates/#/page/99-->

0 comments on commit 9b2b6b9

Please sign in to comment.