CONTRIBUTING.md

FOR CONTRIBUTORS

まず、開発に興味を持ってくださりありがとうございます。本ドキュメントでは、開発の手引きとして本プロジェクトへの貢献方法をご紹介しています。

How to contribute

当該Repositoryにcontributeする方法はいくつか存在します。

Issues起案で貢献する

Issueを起案することでProjectに貢献することができます。Issueを起案することはContributor、Maintainerなどの権限に依らず全員が行うべきことであり、これにより議論の透明性などが上昇すると考えています。

また、本プロジェクトではIssue駆動開発にて開発をおこなっています。projectボードにて、進捗を管理し、次へのアクションを決めております。積極的な議論を期待します。

Issueはテンプレートを元に記述を行ってください。

開発で貢献する

開発で貢献する場合は以下のStepを踏んでください。

1. Assigneeを設定する

Issueに対してAssigneeを指定することで、関係者であることをチームに示します。

また、Assigneeがすでに指定されているIssuesに関しても、追加することが可能です。

projectボードにおいてAssigneeを登録するにはTeamへの登録が必要です。DiscordにてTeamにinvite致しますので、 @suguru-toyohara までメンションをお願い致します。 その他projectボードにないissueに関しては独自に作成し、独自にassigneeにすることが可能です。

2. Repositoryをforkしてbranchを作成する

当repositoryを自分のアカウト内にforkし、ローカル環境にcloneします。その後、新しいbranchを作成しcheckoutして開発を進めてください。

3. Pull Requestを立てる

Pull Requestをテンプレートを元に記述を行なってください。適切なレビュワーが割り振られ、レビューが行われるはずです。 その後、Pull RequestがMergeされたらあなたの貢献がコードに取り込まれます。

Discordサーバに参加する

本プロジェクトはDiscordサーバでも活発な議論が行われています。興味がある場合は是非参加してください。