リポジトリの説明¶
本リポジトリは GitHub をメインとし、GitCode をミラーとしています。
- メインリポジトリ:https://github.com/MS33834/autoship-cli
- GitCode ミラー:https://gitcode.com/badhope/autoship-cli
Issue と Pull Request は GitHub メインリポジトリ に直接提出してください。GitCode はコードミラーのみに使用し、Issue/PR は処理しません。
貢献ガイド¶
AutoShip-CLI への関心ありがとうございます!コミュニティからの貢献を歓迎し、奨励しています。
行動規範¶
本プロジェクトに参加することは、当社の行動規範に従うことに同意したものとみなされます。
貢献方法¶
- バグ報告:GitHub Issues を使用し、再現手順、環境情報、最小再現例を添付してください。
- 提案:GitHub Discussions でアイデアを共有してください。
- コード提出:リポジトリをフォークし、フィーチャーブランチを作成し、Pull Request を提出してください。
開発環境¶
本プロジェクトは uv で依存関係を管理しています。
コード規範¶
- ruff でフォーマットと lint を行います。
- pyright で厳格な型チェックを行います。
- コミットメッセージは英語で、Conventional Commits 規範に従います。
- 新機能にはテストが必須で、カバレッジ 85% 以上を維持してください。
Pull Request の提出¶
- すべてのチェックがパスすることを確認:
uv run ruff check src tests、uv run pyright、uv run pytest。 - セキュリティスキャンを実行:
uv run bandit -r src -ll。 - PR の説明に変更理由、影響範囲、テスト方法を記載。
- メンテナーのレビューを待ち、必要に応じて修正を行う。
Registry へのプラグイン提出¶
サードパーティプラグインを歓迎します!以下のフローで提出してください:
autoship-sdkを使用してプラグインプロジェクトを作成し、PyPI に公開。- GitHub で Plugin Submission テンプレートを選択して issue を作成。
- メンテナーが以下のチェックリストで審査:
- プラグインが AutoShip hook spec に従い、未認可の操作を行わない。
- README、オープンソースライセンス、基本テストを含む。
- 名称が既存プラグインと競合せず、
autoship-*の命名規則に合致。 verifiedを申請する場合は SHA256 チェックサムまたは GPG 署名を提供。- 審査通過後、プラグインは
src/autoship/registry/plugins.jsonに追加され、 Plugin Registry Web UI に自動的に表示されます。
ライセンス¶
コードを貢献することで、貢献した内容がプロジェクトと同じ MIT ライセンスで提供されることに同意したものとみなされます。