コンテンツにスキップ

Contribution Guide

navara プロジェクトへの貢献に興味を持っていただき、ありがとうございます。このガイドでは、プロジェクトに貢献するための方法と手順について説明します。

各ライブラリの開発環境をセットアップするには、対応する GitHub リポジトリの README を参照してください。 各リポジトリには詳細なセットアップ手順とローカル開発の方法が記載されています。

  • 関連する Issue が存在するか確認し、なければ新しい Issue を作成してください
  • テンプレートに沿って必要な情報を Issue に記入してください
  • 変更内容について事前に議論することで、効率的な開発が可能になります
  1. リポジトリをフォークし、新しいブランチを作成
  2. 変更を実装し、適切なテストを追加
  3. コードスタイルと linting ルールに従っているか確認
  4. コミットメッセージは明確で説明的に記述
  • 変更内容の概要と目的を明確に記述
  • 関連する Issue 番号を参照
  • テスト結果とスクリーンショット(該当する場合)を添付
  • レビューアーからのフィードバックに迅速に対応

このドキュメントサイトの改善も大歓迎です:

  • 誤字・脱字の修正: 小さな修正でも大変助かります
  • 内容の追加・更新: 新しい情報や詳細な説明の追加
  • 翻訳: 英語版から日本語版への翻訳、またはその逆
  • 例示の追加: コードサンプルや使用例の追加
  1. ドキュメントリポジトリに Issue または PR を作成
  2. 変更内容を明確に説明
  3. 可能であれば、変更前後のスクリーンショットを添付