Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 2.88 KB

貢献方法

このプロジェクトを実現するために、ボランティアの開発者を求めています!
この文章を読んでくださっているということは、興味を持っていただけたということでとても嬉しいです。

以下に重要なリソースをまとめました:

  • UniProject公式サイト - 私たちがどんな団体か、そしてこのリポジトリの運営者について知ることができます。

テストについて

主にNext.jsを使用しています。以下の点を確認してください:

  • npm run buildnpm run startが問題なく実行できるか
  • コンポーネントが正常に動作しているか

変更内容の提出方法

このリポジトリにPullRequestを送信してください。 その際に、行った変更内容のリストを明確に記載してください。Pull Requestについてはこちらを参照してください。(GitHub Help - Pull Request)。
テストのカバレッジ向上も大歓迎です!以下のコーディング規約を遵守し、すべてのコミットを1つの機能単位(アトミック)で行うようにしてください。

コミットには必ず明確なログメッセージを記載してください。小さな変更であれば1行のメッセージで問題ありませんが、大きな変更の場合は以下のように記載してください:

$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact." 

コーディング規約

コードを読み進めるうちに、規約がわかるようになります。私たちは読みやすさを重視しています:

  • インデントは4スペース(ソフトタブ)を使用
  • リスト項目やメソッドの引数の後、演算子の前後、ハッシュの矢印(=>)の周りには必ずスペースを入れます
    (例:[1, 2, 3]x += 1x => x * 2[1,2,3]x+=1はNG)
  • このプロジェクトはオープンソースです。あなたのコードを読む人のことを考え、読みやすいコードを心がけてください。
    例えるなら、車の運転と同じです。1人のときは自由にスピンターンを楽しむかもしれませんが、乗客がいるときは快適な運転を目指しましょう。

権利関係

このサイトはLICENSEにもあるように、外部の方の著作物も含まれています。 日本の二次創作に対する寛大な価値観をもとに成り立っています。 原作者の方への感謝を忘れず、新しくクレジットを記載したり、クレジットを修正、削除する場合は、CREDITS.mdを編集してください。

よろしくお願いします!
Yuito Akatsuki, UniProject