Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 2.77 KB

File metadata and controls

39 lines (27 loc) · 2.77 KB

RPGアツマール github コントリビューションガイド

RPGアツマール では、一部のソースコードやドキュメントを オープンソースソフトウェア としてgithub上で公開しています。 これらはライセンスの範囲内で誰でも自由に利用することができ、また誰でもissueを報告したり、プルリクエストを行うことができます。


問題報告について(プラグインのバグ、ドキュメントの不備など)

アツマールがGithubで公開しているリソースについてのバグや不備の報告は、Githubのissueから行うことができます(Githubが苦手な場合、Twitterで報告することもできます)。 報告を行う前に、以下のことを確認してから送ってください。

同じ・似た内容のissueがすでにないか調べる

すでにGithubのissue上に同じ内容の報告がないか検索し、調べてください。 また、近い内容のissueがある場合に、そこへコメントする形でご自身の問題報告をしていただいても問題ありません。

報告の形式について

報告をする際に、誤解なく問題が伝わるように以下のことに注意してください。

  • 何が問題であるか、要点を記述する
  • (プラグインへのバグ報告の場合) 実行環境を明記する。OS、ブラウザ、コアスクリプトのバージョン、通信環境(アップロード/ダウンロード速度)など
  • (プラグインへのバグ報告の場合) 問題が再現する手段があれば、再現方法を記載する

機能の修正リクエスト(プルリクエスト)について

アツマールがGithubで公開しているリソースについて、バグや不備をご自身で修正したり、機能を追加したりした場合はプルリクエストを送り、修正の取り込みを依頼することができます。 プルリクエストを行う際は、以下のことに注意してください。

報告の形式について

修正の意図が正しく伝わるように、以下のことに注意してください。

  • 修正内容について、簡潔に記述する
  • 修正の理由について、簡潔に記述する
  • その他注意事項があれば記述する

Github外での議論について

Twitter で気軽に質問してください!