Skip to content

Commit

Permalink
chore: add GitHub issue and pull request templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremylvln committed Sep 23, 2020
1 parent 6486b51 commit 718ff9b
Show file tree
Hide file tree
Showing 4 changed files with 103 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @IamBlueSlime
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: 'Bug Report'
about: "Something isn't working as expected."
title: ''
labels:
- type:bug :beetle:
assignees: ''
---

## Bug Report

## Current behavior

<!-- Describe how the issue manifests. -->

## Expected behavior

<!-- A clear and concise description of what you expected to happen (or code). -->

## Possible Solution

<!--- Only if you have suggestions on a fix for the bug -->

---

**Others:**

<!-- Anything else relevant? Operating system version, IDE, package manager, ... -->
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: 'Feature Request'
about: 'This is something we may need.'
title: ''
labels:
- type:feature :rocket:
assignees: ''
---

## Feature Request

## Is your feature request related to a problem? Please describe.

<!-- A clear and concise description of what the problem is. Ex. I have an issue when [...] -->

## Describe the solution you'd like

<!-- A clear and concise description of what you want to happen. Add any considered drawbacks. -->

## Teachability, Documentation, Adoption, Migration Strategy

<!-- If you can, explain how users will be able to use this and possibly write out a version of the docs. Maybe a screenshot or design? -->

## What is the motivation/use case for changing the behavior?

<!-- Describe the motivation or the concrete use case. -->
48 changes: 48 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
## PR Checklist

Please check if your PR fulfills the following requirements:

```
- [ ] The commit message follows our guidelines
- [ ] Tests for the changes have been added (if applicable)
- [ ] Docs have been added / updated (if applicable)
```

## PR Type

What kind of change does this PR introduce?

<!-- Please check the one that applies to this PR using "x". -->

```
- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, local variables)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] CI related changes
- [ ] Other... Please describe:
```

## What is the current behavior

<!-- Please describe the current behavior that you are modifying or link to a relevant issue. -->

Issue Number fixed #n/a

## What is the new behavior

<!-- Please describe the new behavior that you are submitting. Code samples appreciated. -->

## Does this PR introduce a breaking change

<!-- Please check the one that applies to this PR using "x". -->

```
- [ ] Yes
- [ ] No
```

<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->

## Other information

0 comments on commit 718ff9b

Please sign in to comment.