secretctl へのコントリビュート
secretctl への貢献に興味を持っていただきありがとうございます!このプロジェクトはオープンソースであり、あらゆる種類の貢献を歓迎します。
貢献の方法
バグ報告
バグを見つけましたか?以下の情報を含めてissue を開いてください:
- 問題の明確な説明
- 再現手順
- 期待される動作と実際の動作
- 環境(OS、Go バージョン、secretctl バージョン)
機能提案
新機能のアイデアがありますか?以下を記載した issue を開いてください:
- 解決しようとしているユースケース
- 機能の動作方法
- 検討した代替案
コードの提出
コードを貢献する準備ができましたか?開発セットアップガイドを参照してください。
- リポジトリをフォーク
- 機能ブランチを作成(
git checkout -b feature/your-feature) - テスト付きで変更を実施
go test ./...とgolangci-lint runを実行- プルリクエストを提出
ドキュメントの改善
ドキュメントの改善はいつでも歓迎です:
- タイポの修正や不明瞭なセクションの明確化
- 例やユースケースの追加
- ドキュメントの翻訳
行動規範
- 敬意を持ち、建設的であること
- 人ではなく問題に焦点を当てること
- 他の人が学び成長できるよう支援すること
はじめに
- 開発セットアップ - 開発環境のセットアップ
- アーキテクチャ概要 - システム設計の理解
- GitHub Issues - 取り組む issue を見つける
プルリクエストガイドライン
提出前に
- すべてのテストを実行:
go test ./... - リンターを実行:
golangci-lint run - 必要に応じてドキュメントを更新
- 新機能にはテストを追加
PR の説明
以下を含めてください:
- 変更内容
- なぜ必要か
- テスト方法
- 関連する issue 番号
レビュープロセス
- メンテナーが PR をレビュー
- フィードバックに対応
- 承認後、メンテナーがマージ
ライセンス
貢献することにより、あなたの貢献が Apache 2.0 ライセンスの下でライセンスされることに同意したものとみなされます。