Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

35 lines (21 loc) · 1.79 KB

Contribution Guide

Flocon へのコントリビューションに関するガイドです。

Issues

次の Issues を受け付けています。

  • 機能追加の要望
  • コードに関する質問
  • バグ報告、もしくはバグであると断定できないがバグだと思われる事象に関する報告
  • 誤字の報告
  • サーバーの設置方法に関する質問

その他の Issue も歓迎しています。

Pull Request

基本的には、Pull Request を作成する前に Issue を立てて相談するほうが無難です。

ただし、小規模な修正に関する Pull Request の場合、Issue を立てずに Pull Request を送ってもらっても問題ありません。「小規模な修正」の大まかなな目安(あくまで目安ですので、必ずしもこれらを厳密に守る必要はありません)は、「コードや文章の変更規模がだいたい数行~十数行程度であること」なおかつ次のいずれかを満たすことです。

  • 仕様ではなくバグと思われるコードの修正
  • ドキュメントやコメントなどの誤字の修正
  • MarkDown や TSDoc などの文法エラー

Pull Request の作り方

基本的には、mainブランチにfeature/***(***は変更の概要を表すタイトルなどを付けてください。例 feature/improve-readme)というブランチを生やして Pull Request を作成します。

ただし、mainブランチから生やすのが妥当かどうかが不明な場合(例えば Flocon が動かないなどといった急を要するバグの修正)は、事前に Issue を立てることを推奨します。

ビルドおよびテストの方法

README_developer.md を参照してください。