chore: update pull request template #58
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's Guide by SourceryThis PR updates the pull request template to streamline the checklist and improve clarity. It condenses several checklist items, combines related checks, and removes the explicit Conventional Commits specification from the checklist, as it is already mentioned in the contributing guidelines. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @JaeAeich - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider keeping the explicit conventional commits checkbox to ensure consistent commit message formatting, while maintaining the improved template conciseness.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
uniqueg
requested changes
Jan 9, 2025
{{ cookiecutter.project_name_dashed }}/PULL_REQUEST_TEMPLATE.md
Outdated
Show resolved
Hide resolved
{{ cookiecutter.project_name_dashed }}/PULL_REQUEST_TEMPLATE.md
Outdated
Show resolved
Hide resolved
| - \[ \] I have provided appropriate documentation | ||
| ([Google-style Python docstrings][py-doc-google]) for all | ||
| packages/modules/functions/classes/methods or updated existing ones | ||
| - \[ \] My changes generate no new warnings |
There was a problem hiding this comment.
Are we checking for this?? If not, please re-add
There was a problem hiding this comment.
ruff enforces google docstring and CI fails if docstrings are not written.
{{ cookiecutter.project_name_dashed }}/PULL_REQUEST_TEMPLATE.md
Outdated
Show resolved
Hide resolved
uniqueg
requested changes
Jan 10, 2025
| - \[ \] I have provided appropriate documentation | ||
| ([Google-style Python docstrings][py-doc-google]) for all | ||
| packages/modules/functions/classes/methods or updated existing ones | ||
| - \[ \] My changes generate no new warnings |
| works | ||
| - \[ \] New and existing unit tests pass locally with my changes | ||
| - \[ \] I have not reduced the existing code coverage | ||
| 1. [] My code follows the [contributing guidelines][contributing-guidelines] |
There was a problem hiding this comment.
What do you think about prompting users for contributing guidelines and use the ELIXIR Cloud & AAI ones as default?
There was a problem hiding this comment.
Lets do that later, first make a good one for ECAAI and then consider such generalizations.
{{ cookiecutter.project_name_dashed }}/PULL_REQUEST_TEMPLATE.md
Outdated
Show resolved
Hide resolved
|
Change to unordered list, looks wierd.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates the pr template for cookicutter repo and also relax/shorten for the proj generated by it. Also fixes formatting issue with mdformat.
Comments
Summary by Sourcery
Simplify the pull request template by reducing the number of checklist items and grouping related items together.
Documentation:
Chores: