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: Adds a Pull Request template #1000

Merged
merged 2 commits into from
Nov 15, 2024
Merged

ci: Adds a Pull Request template #1000

merged 2 commits into from
Nov 15, 2024

Conversation

ns-rse
Copy link
Collaborator

@ns-rse ns-rse commented Nov 15, 2024

As suggested by @SylviaWhittle we could all do with an aide memoire when making Pull Requests that we have covered everything we should.

This Pull Request therefore introduces just such a template to aid contributors in making sure we have covered everything.


  • Existing tests pass. N/A no changes to code base introduced.
  • Documentation has been updated and builds. N/A no changes to code base introduced.
  • Pre-commit checks pass.
  • New functions/methods have typehints and docstrings. N/A no changes to code base introduced.
  • New functions/methods have tests which check the intended behaviour is correct. N/A no changes to code base introduced.

As [suggested](#996 (comment)) by @SylviaWhittle we could all do
with an _aide memoire_ when making Pull Requests that we have covered everything we should.

This Pull Request therefore introduces just such a template to aid contributors in making sure we have covered
everything.

---

- [ ] Existing tests pass. **N/A** no changes to code base introduced.
- [ ] Documentation has been updated and builds. **N/A** no changes to code base introduced.
- [x] Pre-commit checks pass.
- [ ] New functions/methods have typehints and docstrings. **N/A** no changes to code base introduced.
- [ ] New functions/methods have tests which check the intended behaviour is correct. **N/A** no changes to code base
  introduced.
Copy link
Collaborator

@SylviaWhittle SylviaWhittle left a comment

Choose a reason for hiding this comment

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

This is a very good idea, thank you.

I've added a suggestion listing suggestions for documentation files to update, but feel free to ignore.

.github/pull_request_template.md Outdated Show resolved Hide resolved
@ns-rse ns-rse force-pushed the ns-rse/pull-request-template branch from d0f31b8 to 3a86a79 Compare November 15, 2024 11:22
@ns-rse ns-rse merged commit 573849c into main Nov 15, 2024
2 checks passed
@ns-rse ns-rse deleted the ns-rse/pull-request-template branch November 15, 2024 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants