Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Define a pull request template

未关闭
#33 3 条评论 0 个 reaction 已指派 4 人 在 GitHub 查看

@benoit74 已经在做这个了。

开始于 2023年12月22日。

评估

这个 Issue 还没有评估数据。

描述

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.

主要语言
Python
星标
1
派生
2
PR 合并指标
30 天内没有已合并 PR

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

openzim/_python-bootstrap 的其他 Issue

查看 openzim/_python-bootstrap 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。