Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
85 lines (51 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

85 lines (51 loc) · 3.02 KB

Contributing to KintoneNetLibrary

本ドキュメントでは、KintoneNetLibrary への貢献方法について説明します。本ライブラリは、.NET による Kintone 連携をより便利かつ拡張性の高いものとするため、コミュニティからの改善提案や Pull Request を歓迎します。

1. 貢献の前に

貢献を行う前に、以下をご確認ください。

  • 本リポジトリの README を参照し、ライブラリの目的・設計思想を理解していること
  • Issue や Pull Request の内容が、既存の議論と重複していないこと
  • コーディング規約やプロジェクト構成に沿っていること

2. Issue の作成

バグ報告、改善提案、機能追加の要望などは Issue を作成してください。

Issue には以下の情報を含めると、議論がスムーズに進みます。

  • 発生した問題または提案内容の概要
  • 再現手順（バグの場合）
  • 期待する動作
  • 使用している .NET のバージョン
  • 関連するログやコード断片（可能な範囲で）

3. Pull Request の作成

Pull Request（PR）は歓迎します。PR を作成する際は、以下の点にご留意ください。

3.1 ブランチ戦略

  • main ブランチは安定版です。
  • 新規機能や修正は feature/xxxx または fix/xxxx のようなブランチ名で作成してください。

3.2 PR に含めるべき内容

  • 変更内容の概要
  • 変更の背景（Issue 番号があれば記載）
  • 動作確認方法
  • 影響範囲（API 互換性、既存コードへの影響など）

3.3 コーディング規約

  • C# の一般的なコーディング規約（Microsoft 推奨スタイル）に従ってください。
  • 非同期メソッドは Async サフィックスを付けてください。
  • 例外は必要な場合にのみ使用し、明確なメッセージを含めてください。
  • テストコードが必要な変更の場合は、単体テストを追加してください。

4. テスト

本ライブラリでは、品質維持のため単体テストを重視しています。

  • 新規機能追加時は、可能な範囲でテストを追加してください。
  • 既存機能の修正時は、関連テストの更新または追加を行ってください。

5. ドキュメント

README や docs/ 以下のドキュメントに影響する変更を行った場合は、必要に応じてドキュメントも更新してください。

6. コミュニケーション

議論や質問は Issue または Pull Request 上で行ってください。
建設的で丁寧なコミュニケーションを心がけていただけると助かります。

7. ライセンス

本プロジェクトへの貢献は、MIT License の下で提供されることに同意したものとみなします。

ご協力に感謝します。
KintoneNetLibrary がより良いライブラリとなるよう、皆さまの貢献を歓迎します。