How to contribute

mochiOS Contributing Guideline

まず、mochiOSはあらゆる貢献を歓迎します。
なぜなら、このOSはオープンで、あらゆる学習者、開発者、学生にとってコードを書いたり、参入したりしやすいOSを目指しているからです。

そして、mochiOSへ貢献する方法は多岐にわたります。
ここでは、その中の3つをピックアップしてそれぞれの貢献の仕方、やって欲しいこと、やらないで欲しいことを書いています。
もちろん、ここに書かれていない貢献の仕方でも構いません!どんなコントリビュートでも歓迎します。

Method 01

バグを報告する

Githubのissueに以下の手順で報告してください。

  1. New issueを押す
  2. バグの報告を押す
  3. タイトルのBug report:の後にわかりやすいバグのタイトル(例: マウスを連打しすぎるとクラッシュする)を書く
  4. 概要、動作、発生箇所をできる限り詳細に書く(後できればシリアル出力とかスクショも欲しいですが、なくても全然構いません。また詳細にと言ってはいますが伝われば十分です!)
  5. Createを押す

これだけで終わりです。
これはちょっと難しいよ〜泣という方は公式Discordのdiscussチャンネルに投げてくれると、多分誰かが対応してくれます。

報告してくれるだけでもめちゃくちゃありがたいので、ぜひお願いします!

Method 02

新しいアイデアを共有する

Githubのissueの機能の提案テンプレートを活用するか、公式Discordのfreechat、またはdiscussチャンネルに投げてくれると嬉しいです。
採用された場合はContributorsリストに載ります!

どんな些細なアイデアでも構いませんし、ジョークアイデアでもOKです。

Method 03

コードを書いてパッチを送信する

コードのフォーマットはcargo fmtしてれば大丈夫です。
ですが、できる限りよみやすく、わかりやすいコードを心がけてください。特に細かいルールはありません。

作成後はGithubのPull Requestから送信してください。また、各アプリケーション(例えばDock)にコントリビュートしたいときは、そのアプリのリポジトリにPullRequestを送信してください。

【AIの利用について】
AIの利用は構いませんが、自分でレビューして、そのコードに責任が持てない限りは送信しないでください。
たまに頭の悪いパッチを送信してくる人がいますが、コミュニティは拒否します。

また、Co-authored-byにAIのユーザー(例えばClaude)を付与したり、コミットをAI名義でしてはいけません。(誰がコードを書いたのか不明瞭になるため)

コードを書いてくれることはとても嬉しいのでお待ちしています。

OSづくりを始めよう

ソースコードはすべて公開しています。
fork、改造、貢献、質問、すべて歓迎します。

GitHub で見る ドキュメントを読む