UCL-ARC / UCL-ARC/python-tooling
Add contributors guidelines to template
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 62
- フォーク
- 10
- 平均マージ
- 7日 6時間
- マージ済み PR(30日)
- 6
説明
Is Your Feature Request Related to a Problem? Please Describe
Currently the package template does not include a CONTRIBUTING.md guidelines page, but this is quite a well suited page for templating given a basic guide can use largely pro-forma text with a few templated links. While it will need to be relatively generic, I think having something basic included by default in template would be good.
Describe the Solution You'd Like
A CONTRIBUTING.md contributors guide in the cookicutter template. We added a basic guide to S2FFT recently which could be used as starting point (as could probably many others this one is just recent in memory!).
Describe Alternatives You've Considered
No response
Additional Context
No response
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Start by locating the cookiecutter package template and reviewing the linked S2FFT CONTRIBUTING.md guide as a possible model. Add a generic CONTRIBUTING.md with templated links, then verify that newly generated Python packages include the guide and that its links are appropriate for the template.
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation, tooling
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 55/100