nyanp / nyaggle

Code for Kaggle and Offline Competitions
MIT License
290 stars 29 forks source link

コントリビューション時のガイドをまとめたCONTRIBUTING.md作成の提案 #109

Open wakame1367 opened 1 year ago

wakame1367 commented 1 year ago

このリポジトリへのPRやIssue、例えばバグ報告の際にどのようなフォーマットで報告してほしいか、バグを見つけてPRを出すときにどのようにテスト環境を構築すればよいかなどを明記したCONTRIBUTING.mdを書いたほうがよいと思いました。

書く内容以下のような項目かと思いました。

リポジトリコントリビューターのためのガイドラインを定める

nyanp commented 1 year ago

@wakame1367 提案ありがとうございます!現状コミュニティが大きいわけでも無いので、まずは参加(特にPR)のハードルを下げるために必要な最小限のところから書いていくと良さそうです。その観点では、

あたりが比較的優先度が高いのかな、と思いました。

コードスタイルについては、現状のnyaggle自身が綺麗な状態ではないので、mypy/flake8/black(あるいはpysen)をまずレポジトリ全体に適用した上で、ツールで担保する方向にもって良ければよいかなーと思っています。-> #110 を立てました。