Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Define a pull request template

Đang mở
#33 3 bình luận 0 reaction 4 người được giao Xem trên GitHub

@benoit74 đang làm issue này rồi.

Từ ngày 22/12/2023.

Đánh giá

Issue này chưa được đánh giá.

Mô tả

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.

Ngôn ngữ chính
Python
Star
1
Fork
2
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của openzim/_python-bootstrap

Tất cả issue của openzim/_python-bootstrap

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.