# JP-MARs basic rule
JP-MARsプロジェクト内のOSS作成基本ルールについて記載します。

-------

## 基本方針
* 本プロジェクトは、実用性と教育性の両方を持つOSSの提供を目的とします。したがって、過度に技巧的なコーディングは避け、可読性も考慮したソースコードになるように配慮してください。（性能向上に寄与するなら、多少の技巧的書き方は許容範囲と思いますが、殆ど性能に対する効果がないのに、過度にプロ仕様なコーディングは避けてください。）<br>
　ソースコード中には、できるだけコメントを残して、どのような処理が行われているかを分かりやすくしてください。コメントは英語・日本語どちらでも構いません（日本人以外には日本語のコメントは邪魔と思いますが、日本発祥ということで日本の学生の教育性を考えることにします）。

* コーディングスタイルは「**最初にその機能（クラス・モジュールなど）を作った人のコーディングスタイルに極力従う**」とします。自動フォーマット機能を使っている場合は、過去のスタイルを崩してしまうことがあると思いますので、一定のご配慮をお願いします。

<br>

* This project aims to provide OSS that is both practical and educational. Therefore, please avoid overly technical coding and ensure that the source code is readable. (A little technical coding is acceptable if it contributes to performance improvement, but please avoid overly professional coding with little or no performance benefit.) Please leave comments in the source code as much as possible to make it easy to understand what is being done. Comments can be in either English or Japanese (Japanese comments are considered a hindrance to non-Japanese, but we will consider the educational nature of Japanese students since it originated in Japan).
* The coding style should **"follow the coding style of the person who first created the feature (class, module, etc.) as much as possible.** If you are using an auto-formatting function, please give certain consideration to the fact that it may break past styles.