Skip to content

Commit

Permalink
Add PR templates (#11)
Browse files Browse the repository at this point in the history
  • Loading branch information
diehlbw authored May 24, 2024
1 parent 6449e2e commit 1aa489c
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Pull Request
* [ ] Verify all tests are passing
* [ ] Update the version in seismometer._version.py
* [ ] Call towncrier to draft the update to the release notes. Delete fragments as needed.
<!-- Do any manual release testing and review here -->
* [ ] Work with the Core team to get approvals
* [ ] Squash merge the release pull request with message "`Release <VERSION>`"

## Post Merge
* [ ] Tag the commit with the matching version vX.Y.Z
* [ ] Create a release from this tag
* [ ] If done prior to a deploy workflow, work with the Core team to publish to PyPI.
* [ ] Make announcement.
14 changes: 14 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Overview
<!-- Update and delete as appropriate; useful reference when you get to news fragments -->
Closes #xxx

## Description of changes
<!-- Describe your changes and any implementation decisions -->
<!-- Especially for enhancements, start conversations early. Ideally in the documenting issue -->
<!-- Can be formatted as a checklist for reviewers. -->

## Author Checklist
- [ ] Linting passes; run early with [pre-commit hook](https://pre-commit.com/#install).
- [ ] Tests added for new code and issue being fixed.
- [ ] Added type annotations and full numpy-style docstrings for new methods.
- [ ] Draft your news fragment in new `changelog/ISSUE.TYPE.rst` files; see [changelog/README.md](https://github.com/epic-open-source/seismometer/blob/main/changelog/README.md).

0 comments on commit 1aa489c

Please sign in to comment.