Skip to content

Commit 537b07b

Browse files
committed
Add pull request templates
1 parent 30ce258 commit 537b07b

File tree

4 files changed

+34
-0
lines changed

4 files changed

+34
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<!-- -----------^ Click "Preview" for a functional view! -->
2+
3+
## Why are you creating this Pull Request?
4+
5+
- [Version Release](?title=Deploy%20vX.X.X&expand=1&template=version_release.md)
6+
- [Other](?expand=1&template=default.md)
+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## What am I changing and why
2+
3+
_Replace with brief description of the update and why it is needed. Link to relevant issues._
4+
5+
## How to test
6+
_Replace with instructions on how this change be tested/verified._
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
_The PR name should be the version to be deployed (ex: v1.0.1)_
2+
3+
- [ ] Bump the version in the package.json or equivalent.
4+
5+
---
6+
7+
# Changelog vX.X.X
8+
9+
## 🎉 Features
10+
-
11+
12+
## 🚀 Improvements
13+
-
14+
15+
## 🐛 Fixes
16+
-

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,9 @@ The following paths are predefined, but feel free to change them to whatever is
7878
```
7979

8080
For example, to import a component from a file called `page-header` in the `"~/app/scripts/components"` folder, you'd just need to do `import Component from '$components/page-header'`.
81+
82+
## Pull Request templates
83+
84+
Project seed comes with pull request templates to simplify and standardize the pull requests in the project. This [issue on the how repo](https://github.com/developmentseed/how/issues/360#issuecomment-1041292591) provides some context to how this works.
85+
86+
To add more templates create them in the `.github/PULL_REQUEST_TEMPLATE` folder and link them in the [PULL_REQUEST_TEMPLATE.md](./.github/PULL_REQUEST_TEMPLATE.md) file.

0 commit comments

Comments
 (0)