Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: pull request template #517

Merged
merged 15 commits into from
Mar 4, 2024
28 changes: 28 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## ✨ Context

<!--- What's the context for the changes? If the changes are related to a specific issue, please [link](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to it:_
d0choa marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<!--- What's the context for the changes? If the changes are related to a specific issue, please [link](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to it:_
<!---
Congratulations! You've made it this far!
Once merged, your PR is going to appear in the release notes with the title you set, so make sure it's a great title that fully reflects the extent of your contribution.
What's the context for the changes? If the changes are related to a specific issue, please [link](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to it:_


- This PR fixes or closes issue: fixes #
- This PR is related to issue:

-->

## 🛠 What does this PR implement

<!--- _Detailed description of the changes introduced, Give examples of the changes you've made in this pull request, include an itemized list if you can and
add diagrams or images if necessary. It'll help the reviewer_ -->

## 🙈 Missing

<!--- If there are things that are requested in the task and were not implemented, list them here -->

## 🚦 Checks
d0choa marked this conversation as resolved.
Show resolved Hide resolved

- [ ] covers one single feature (one change at a time)
d0choa marked this conversation as resolved.
Show resolved Hide resolved
- [ ] documentation added/updated
d0choa marked this conversation as resolved.
Show resolved Hide resolved
- [ ] there is no commented out code in this PR
d0choa marked this conversation as resolved.
Show resolved Hide resolved
- [ ] follows [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) in PR title and commits.
d0choa marked this conversation as resolved.
Show resolved Hide resolved
- [ ] is up-to-date with `dev` branch
d0choa marked this conversation as resolved.
Show resolved Hide resolved
- [ ] tests have been added to verify that the new code works
d0choa marked this conversation as resolved.
Show resolved Hide resolved
- [ ] passes local tests (`make test`)
d0choa marked this conversation as resolved.
Show resolved Hide resolved
- [ ] passes pre-commits (e.g `poetry run pre-commit run --all-files`)
d0choa marked this conversation as resolved.
Show resolved Hide resolved