Skip to content

Commit

Permalink
Add a Pull Request and Issue template to .github (#117)
Browse files Browse the repository at this point in the history
* Add a Pull Request template and an Issue template

* Run prettier
  • Loading branch information
mdial89f authored Feb 23, 2021
1 parent f3d9bbb commit db37435
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 0 deletions.
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
## Type of Issue:

- [ ] Bug: Something isn't working
- [ ] Enhancement: New feature or request
- [ ] Question: Further information is requested (I have a question)

#### Issue Creator Checklist

- [ ] The appropriate label (bug, enhancement, question) has been attached to this issue.
- [ ] This issue has been thoroughly documented below; a developer should be able to understand the issue by reading it.

<br /><br />_Please complete the sections that pertain to your issue type, and delete the sections that don't_

<br /><br />_For bugs:_

## What's broken?

_List a description of the bad behavior or failure. Please be as detailed as possible. Attach screenshots if appropriate_

## What's the impact of this bug?

\_What's the impact to the end user experience and/or application in general

## Assorted Notes/Considerations

_List any other information that you think is important_

## AC:

_List the acceptance criteria for this issue._

<br /><br />_For enhancements:_

## Background

_History or background behind this enahancement request._

## AC:

_List the acceptance criteria for this issue._

<br /><br />_For questions:_

## Question / Request for more Info

_What's your question? Or, what would you like more information on? Don't be afraid to use plain english_

## AC:

_List the acceptance criteria for this issue. "Answering the question" is acceptable here._
39 changes: 39 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## Purpose

_Describe the problem or feature in addition to a link to the issues._

#### Linked Issues to Close

_Links to issue(s) that are closed by this PR. Be sure to use the phrase "Closes #XXX" for each issue, so they automatically close_

## Approach

_How does this change address the issue?_

## Learning

_Describe the research stage_

_Links to blog posts, patterns, libraries or addons used to solve this problem_

## Assorted Notes/Considerations

_List any other information that you think is important... a post-merge activity, someone to notify, etc._

#### Pull Request Creator Checklist

- [ ] This PR has an associated issue or issues.
- [ ] The associated issue(s) are linked above.
- [ ] This PR meets all acceptance criteria for those issues.
- [ ] This PR and linked issue(s) are adequately documented
- [ ] This PR and linked issues(s) are a complete description of the changeset; an individual or team should be able to understand the issue(s) and changes by reading through this PR and it's links, with no further interaction.
- [ ] Someone has been assigned this PR.
- [ ] At least one person has been marked as reviewer on this PR.

#### Pull Request Reviewer/Assignee Checklist

- [ ] This PR has an associated issue or issues.
- [ ] The associated issue(s) are linked above.
- [ ] This PR meets all acceptance criteria for those issues.
- [ ] This PR and linked issue(s) are adequately documented
- [ ] This PR and linked issues(s) are a complete description of the changeset; an individual or team should be able to understand the issue(s) and changes by reading through this PR and it's links, with no further interaction.

0 comments on commit db37435

Please sign in to comment.