Define a pull request template
@benoit74 is already working on this.
Since Dec 22, 2023.
Assessment
This issue has not been assessed yet.
Description
Some projects have a pull_request_template.yml, but it does not look like there is a convention on this yet.
The template I've found so far is:
## Rationale
[//]: # (Briefly explain the reason behind this change.)
<!--
Issue: [Title](link) or #123 for Github issues.
-->
## Changes
[//]: # (Summarize what has changed.)
Some inconvenient I find in this template:
- I do not find the term "Rationale" very obvious
- There is no mention about the fact that we must add "Fix: ###" to automatically close issues.
- The "Issue" template is misleading, it looks like it will do something automatically while it doesn't + all issues should be Github issues (or most at least), so no need to propose something for the case where it is not
ChatGPT suggested me the following sections:
## Description
<!-- Describe the purpose of this pull request -->
## Changes Made
<!-- List the changes made in this pull request -->
## Screenshots (if applicable)
<!-- Include screenshots or images demonstrating the changes -->
## Testing
<!-- Explain how the changes were tested -->
## Related Issues
<!-- Mention any related issues or link to them -->
## Checklist
- [ ] Code follows project standards
- [ ] Tests have been added/updated
- [ ] Documentation has been updated
- [ ] Changelog entry added
And it should be named pull_request_template.md (it's not a yaml file 😅)
My remarks on ChatGPT suggestion:
- I think the related issues should be clearer about the fact that we expect one or more "Fix: ###" and I would like to put this at the beginning of the PR, just after the description (or even before that) so that it is more obvious why we are proposing this PR
- in the checklist:
- we should add a link to our project standards so that it is obvious
- most scrappers do not have tests (yet, at least) ; and usually there structure makes testing a daunting task ; I think we should not add this check in most scrapers yet
- documentation should refer to usage + wiki
I welcome all suggestions on this, I can handle the creation of a PR once arguments have settled a little bit.
- Dominant language
- Python
- Stars
- 1
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from openzim/_python-bootstrap
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 76/100
openzim/_python-bootstrap#57 ·
-
enhancement
openzim/_python-bootstrap#54 · 1 comment · 2 assignees ·
-
Workflow convention Openquestion
openzim/_python-bootstrap#53 · 1 assignee ·
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 25/100
openzim/_python-bootstrap#51 · 3 comments ·
-
enhancement
openzim/_python-bootstrap#48 · 2 assignees ·
All issues in openzim/_python-bootstrap
Similar issues
-
Add: hunch Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AbdelStark/awesome-typesafe#104 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
DiamondLightSource/dodal#2211 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
openml/openml-python#1749 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
sipyourdrink-ltd/bernstein#6191 ·