Komonへの貢献

Komonへの貢献に興味を持っていただき、ありがとうございます！

🐧 プラットフォーム方針

KomonはLinux環境専用として開発されています。

作者の方針

Linux環境での実用性と品質を最優先
Windows/macOS版は作者自身では開発しない
他のプラットフォームへの移植は、フォークによる独立プロジェクトとして歓迎

なぜLinux専用なのか？

実用性: 作者が実際にLinuxサーバで使用するために開発
品質: 限られたリソースを一つのプラットフォームに集中
シンプルさ: クロスプラットフォーム対応の複雑さを避ける
Linux機能の活用: systemd、dnf/apt等を積極的に利用

🤝 貢献の種類

歓迎する貢献

Linux環境での改善
- バグ修正
- 新しいLinuxディストリビューション対応
- パフォーマンス改善
- ドキュメント改善
機能追加
- Linux環境での新しい監視項目
- 通知手段の追加
- ログ分析の改善
テストの追加
- ユニットテスト
- 統合テスト
- CI/CDの改善

他のプラットフォームへの移植について

Windows版やmacOS版を作りたい場合：

フォークして独立プロジェクトとして開発してください
完成したら、ぜひお知らせください
本家READMEにリンクを掲載させていただきます

例：

Komon-Windows - Windows版フォーク
Komon-macOS - macOS版フォーク

📝 貢献の流れ

1. Issue を作成

まず、何を改善したいか、何を追加したいかをIssueで議論しましょう。

2. Fork & Clone

# リポジトリをフォーク後
git clone https://github.com/your-username/Komon.git
cd Komon

3. ブランチを作成

git checkout -b feature/your-feature-name

4. 開発

# 開発モードでインストール
pip install -e .

# 変更を加える
# テストを追加

5. テスト

# テストを実行（今後実装予定）
pytest tests/

# 実際に動作確認
komon status
python scripts/main.py

6. コミット

git add .
git commit -m "feat: 新機能の説明"

コミットメッセージは以下の形式を推奨：

feat: - 新機能
fix: - バグ修正
docs: - ドキュメント
refactor: - リファクタリング
test: - テスト追加

7. Pull Request

GitHubでPull Requestを作成してください。

🎯 開発ガイドライン

コーディングスタイル

PEP 8に準拠
日本語コメント・メッセージOK（Komonの特徴です）
絵文字の使用を推奨（ユーザーフレンドリーに）

設計原則

シンプルさ: 複雑な実装より、シンプルで理解しやすいコードを優先
実用性: 実際に使える機能を重視
拡張性: 新しい機能を追加しやすい設計
Linux特化: クロスプラットフォーム対応は考慮しない

ドキュメント

コードを変更したら、以下も更新してください：

docs/README.md - 機能説明
.kiro/specs/komon-system.md - 仕様書
docs/CHANGELOG.md - 変更履歴

🔍 仕様駆動開発

Komonは仕様駆動開発を採用しています。

仕様を書く: .kiro/specs/komon-system.mdに追記
実装する: src/komon/にコードを追加
テストを書く: tests/にテストを追加
ドキュメント更新: 関連ドキュメントを更新

💬 質問・相談

Issue: 機能提案、バグ報告
Discussion: 一般的な質問、アイデア

📜 ライセンス

貢献したコードは、MITライセンスの下で公開されます。

🌟 最後に

Komonは「自分が欲しいと思ったものを形にする」という原点から生まれました。

あなたの貢献が、誰かの役に立つツールになることを願っています。

ありがとうございます！

@kamonabe

FilesExpand file tree

CONTRIBUTING.md

Latest commit

History