nyaggle
nyaggle copied to clipboard
コントリビューション時のガイドをまとめたCONTRIBUTING.md作成の提案
このリポジトリへのPRやIssue、例えばバグ報告の際にどのようなフォーマットで報告してほしいか、バグを見つけてPRを出すときにどのようにテスト環境を構築すればよいかなどを明記したCONTRIBUTING.md
を書いたほうがよいと思いました。
書く内容以下のような項目かと思いました。
- 環境設定: 新しい貢献者が開発環境を設定する方法についてのガイド。依存関係のインストール、ローカルでのプロジェクトのセットアップ、テストの実行方法など。
- バグ報告: バグを発見した場合の報告方法。具体的な再現手順、期待する結果、実際の結果などを含む詳細な報告が役立つことを示すこと。
- 新機能の提案: 新しい機能や改善を提案する方法。具体的なユースケースと提案の詳細を提供することが重要であることを強調すること。
- Pullリクエストの提出: 既存の問題を解決するためのPRを作成し、提出する方法。PRを提出する前に全てのテストが通ることを確認すること、変更の詳細な説明を提供することなど。
- コードスタイル: 遵守すべきコーディング規約やスタイルガイドがある場合は、その詳細。
- コミュニティガイドライン: プロジェクトの参加者が遵守すべき行動規範など。
@wakame1367 提案ありがとうございます!現状コミュニティが大きいわけでも無いので、まずは参加(特にPR)のハードルを下げるために必要な最小限のところから書いていくと良さそうです。その観点では、
- 環境設定
- Pullリクエストの提出
あたりが比較的優先度が高いのかな、と思いました。
コードスタイルについては、現状のnyaggle自身が綺麗な状態ではないので、mypy/flake8/black(あるいはpysen)をまずレポジトリ全体に適用した上で、ツールで担保する方向にもって良ければよいかなーと思っています。-> #110 を立てました。