MNEMO開発の手引き

MNEMO(ニーモ)は、TSGが開発しているオープンソースのブラウザゲームです。

子供から大人まで誰でも楽しめるパズルゲームの開発を目標にしていますが、同時にTSG部員を対象にした以下のような教育的プロジェクトでもあります。

というわけで、主にTSG内部での開発にフォーカスしていますが、もちろん外部からのContributeも受け付けているので是非是非。

Though this project is intended for the internal development by TSG, contributions are very open for everyone!

まず何をすればいい?

Issues一覧ページを見てください。当プロジェクトがやりたいこと/やるべきことが一覧になっています。この中から直せそうなタスクを選んで実際に取り組んでみてください。

やることが決まっているタスクには「難易度」のラベルがついているので、自分のスキルやモチベーションと照らし合わせて適切なタスクを選んでください。

取り組むタスクを決めたら、作業のバッティングを避けるために、必ず該当するIssueで担当することを宣言してください。「やります」とか適当にコメントすれば良いです。

開発フローは GitHub Flow を採用しています。TSGメンバーはmasterブランチへのプッシュ権限がありますが、小さな変更以外は必ずブランチを切ってPRを送りレビューを受けてください。

ブランチ名は激しく適当でいいです。

コミットメッセージは日本語か英語(できれば英語)で、簡潔に書いてください。

masterブランチへのマージはsquashではなく通常のマージで行います。

masterとのマージでコンフリクトが起きる場合は、rebaseをお願いする場合があります。自分が作ったブランチへの force push は自由に行って構いません。(masterブランチは保護されており force push できないようになっています)

READMEを読んでください。

MNEMOは共同開発プロジェクトです。MNEMOに記述したプログラムはチーム全体の共有物となるため、コードは誰にでも読みやすく、またスタイルがコードベース全体で統一されている必要があります。

TSG部員はSlackの#mnemoチャンネルまで。

楽しんでください。