Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add issue + PR templates #66

Merged
merged 3 commits into from
Oct 25, 2021
Merged

Add issue + PR templates #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
917a264
Update issue templates
yardasol Oct 18, 2021
692f43f
Create pull_request_template.md
yardasol Oct 18, 2021
57553b5
address madicken's suggestions
yardasol Oct 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug report
about: Report software bugs
title: "[Bug]: "
labels: Type:Bug
assignees: ''

---

**Expected behavior**
A clear and concise description of what you expected to happen.

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1.
2.
3.
4.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**System Specifications:**
- Version:
- Platform:
- Subsystem:

**How can this issue be closed?**
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Feature request
about: Suggest an idea for this project
title: 'Feature: '
labels: Status:1-New, Type:Feature
assignees: ''

---

**Background and motivation**

**Description of idea**

**Implementation details**

**Potential snags**
38 changes: 38 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## Summary of changes
<!--- In one or more sentences, describe the PR you are submitting -->



## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about splitting this list into two separate lists: one with the descriptors for the types of changes and requirements (i.e. all of the "optional" checkboxes), and one with the checkboxes that are required for merging (i.e reading the contributing doc, making sure tests pass)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in most recent commit.

- [ ] 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)

## Required for Merging
- [ ] I have read the **CONTRIBUTING** document.
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because devs will need to run some tests locally that aren't run with CI, this should be expanded to two checkboxes, one related to whether CI passes and one whether the serpent-requiring tests pass locally.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in most recent commit

- [ ] CI tests pass
- [ ] Local tests pass (including Serpent2 integration tests)

## Associated Issues and PRs
<!--- Please note any issues or pull requests associated with this pull request -->

- Issue: #


## Associated Developers
<!--- Please mention any developers who should be alerted of this PR -->

- Dev: @


## Checklist for Reviewers

Reviewers should use [this link](https://arfc.github.io/manual/guides/pull_requests) to get to the
Review Checklist before they begin their review.