Skip to content

Commit

Permalink
repo: Create a Repository PR Template (#854)
Browse files Browse the repository at this point in the history
  • Loading branch information
HappyNTH authored Oct 27, 2024
1 parent 6fbac1d commit 343a890
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---

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

**Reproduction**
A description of the issue area, or steps/queries/mutations to reproduce the behavior.

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

**Additional Context**
Add any other context about the problem here.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Feature request
about: Suggest an enhancement for this project
title: ''
labels: enhancement
assignees: ''
---

**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 [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered, and why you've discounted them.

**Additional Context**
Add any other context or screenshots about the feature request here.

**Implementation Steps**
If you feel confident, provide implementation steps:

- [ ] Update API call 'x'
- [ ] Add to component 'y'
24 changes: 24 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## PR Steps

These steps are to ensure you correctly make a PR. _Please delete them before submitting the PR!_

1. Test and lint your code locally with `make pr` before opening a PR to save yourself time!
2. For almost all development, you should be targeting `dev` rather than `main`. Only releases target `main`!
3. Give your PR a descriptive name, and prefix that name with one of the following options:
- `fix:` for bug fixes
- `feat:` for new features
- `repo:` for repository fixes
- `deps:` for dependency updates
- If your PR does more than one of the above, focus on the primary purpose of your PR. E.g. if you have fixed small bugs in the process of implementing a feature, use `feat:`
4. Tag your PR! It makes it easier to know what's going on at a glance
5. Assign yourself to make clear you're working on it

## Description

A clear and concise description of the changes this PR makes.

## PR Links

- [Example](https://www.example.com)

- Resolves # (issue)

0 comments on commit 343a890

Please sign in to comment.