コンテンツにスキップ

コントリビューションガイド

OpsMini へのご関心と貢献に感謝します!

参加方法

  • バグ報告:GitHub Issues に再現手順、環境情報、ログを添えて投稿
  • 機能提案:Issues に利用シーンと期待を記述
  • コードの投稿:リポジトリを Fork → 新しいブランチを作成 → コミット → Pull Request を作成
  • ドキュメントの整備:ドキュメントの誤りを修正、使用例を補足

コミット規約

  • 1 つの PR は 1 つの変更に集中し、大きすぎる変更を避ける
  • Go 公式のコードスタイルに従う(gofmt / go vet)
  • 新機能にはテストケースを追加
  • コミットメッセージには「何をしたか」「なぜか」を明確に記述

ディレクトリ規約

  • レイヤー構造:api/v1(Controller)→ service(ビジネス)→ repository(データ)
  • センシティブフィールド(シークレット / Token)は暗号化して DB に保存
  • 新しいインターフェースは統一レスポンス { code, message, data } に従う

ライセンス

プロジェクトは Apache License 2.0 を採用しています。コードの貢献はこのライセンスに基づく許諾に同意したものとみなされます。