Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Define a pull request template

Open
#33 3 comments 0 reactions 4 assignees View on GitHub

@benoit74 is already working on this.

Since Dec 22, 2023.

Assessment

This issue has not been assessed yet.

Description

enhancement

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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from openzim/_python-bootstrap

All issues in openzim/_python-bootstrap

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.