Skip to content

Latest commit

 

History

History
15 lines (10 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

15 lines (10 loc) · 1.58 KB

Contributing

⚠️このドキュメントは今後のリリースの為の書きかけです。頻繁に更新されることが予想されるため、現在はこのドキュメントに従う必要はありません。

Should

  • プルリクエスト毎に、新しいブランチを作成することをおすすめします。
  • FlyLibのプルリクエストでは、なるべく大きな単位でのコミットを推奨しています。その際には、具体的に何の機能をどのようにしたか、というメッセージを記述してください。

Must

  • パブリックなクラス、メソッド、変数を追加する場合、それらについてのドキュメントを 指定されたフォーマット に従って記述してください。
  • コードの一貫性を保つため、 指定されたコードスタイル に従ってください。 FlyLibに問題が無い場合、なるべく現在のFlyLibコードスタイルを統一してください。
  • FlyLibは現在ベータ版です。現在は機能の破壊的変更は認められていますが、正式リリース後(バージョン1.0.0以上)は、@Deprecatedアノテーションを使用し、すぐには削除しないでください。
  • FlyLibに対してコミットをする前に、リポジトリのフォークが最新であるかを確認してください。 このようにして フォークを同期することが出来ます。