Skip to content

Commit

Permalink
Update to just feature a PR template
Browse files Browse the repository at this point in the history
  • Loading branch information
HappyNTH committed Oct 27, 2024
1 parent 4e7730e commit 76010d5
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
**PR Steps**
## PR Steps

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

1. For almost all development, you should be targeting `dev` rather than `main`. Only releases target `main`!
2. Give your PR a descriptive name, and prefix that name with one of the following options:
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:`
3. Tag your PR! It makes it easier to know what's going on at a glance
4. Assign yourself to make clear you're working on it
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**
## Description

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

Resolves/Fixes #(issue)
## PR Links

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

- Resolves # (issue)

0 comments on commit 76010d5

Please sign in to comment.