Define a pull request template
@benoit74 がすでに取り組んでいます。
2023年12月22日 から。
評価
この issue はまだ評価されていません。
説明
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 はありません
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
openzim/_python-bootstrap のほかの issue
-
bug
難易度 1/5 1時間未満 初心者へのやさしさ 76/100
openzim/_python-bootstrap#57 ·
-
enhancement
openzim/_python-bootstrap#54 · コメント 1 件 · 担当者 2 名 ·
-
Workflow convention オープンquestion
openzim/_python-bootstrap#53 · 担当者 1 名 ·
-
enhancement
難易度 3/5 1〜2日 初心者へのやさしさ 25/100
openzim/_python-bootstrap#51 · コメント 3 件 ·
-
enhancement
openzim/_python-bootstrap#48 · 担当者 2 名 ·
openzim/_python-bootstrap の issue をすべて見る
似ている issue
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
canonical/paas-charm#368 · コメント 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
tech debt
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
StevenBlack/hosts#3256 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
qualcomm/qai-appbuilder#275 ·