update contribution guides
This commit is contained in:
syuilo
parent
db1fde2956
commit
6384d0708d
3 changed files with 60 additions and 37 deletions
32
.github/PULL_REQUEST_TEMPLATE.md
vendored
32
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -1,34 +1,10 @@
|
||||||
<!-- ℹ お読みください
|
<!-- ℹ お読みください
|
||||||
PRありがとうございます！ PRを作成する前に、以下をご確認ください:
|
PRありがとうございます！ PRを作成する前に、コントリビューションガイドをご確認ください:
|
||||||
- 可能であればタイトルに、以下で示すようなPRの種類が分かるキーワードをプリフィクスしてください。
|
https://github.com/misskey-dev/misskey/blob/develop/CONTRIBUTING.md
|
||||||
- fix / refactor / feat / enhance / perf / chore
|
|
||||||
- また、PRの粒度が適切であることを確認してください。ひとつのPRに複数の種類の変更や関心を含めることは避けてください。
|
|
||||||
- このPRによって解決されるIssueがある場合は、そのIssueへの参照を本文内に含めてください。
|
|
||||||
- CHANGELOG.mdに変更点を追記してください。リファクタリングなど、利用者に影響を与えない変更についてはこの限りではありません。
|
|
||||||
- この変更により新たに作成、もしくは更新すべきドキュメントがないか確認してください。
|
|
||||||
- 機能追加やバグ修正をした場合は、可能であればテストケースを追加してください。
|
|
||||||
- テスト、Lintが通っていることを予め確認してください。
|
|
||||||
- `npm run test`、`npm run lint`でぞれぞれ実施可能です
|
|
||||||
- UIに変更がある場合はスクリーンショットを本文内に添付してください。
|
|
||||||
ご協力ありがとうございます🤗
|
|
||||||
-->
|
-->
|
||||||
<!-- ℹ README
|
<!-- ℹ README
|
||||||
Thank you for your PR! Before creating a PR, please check the following:
|
Thank you for your PR! Before creating a PR, please check the contribution guide:
|
||||||
- If possible, prefix the title with a keyword that identifies the type of this PR, as shown below.
|
https://github.com/misskey-dev/misskey/blob/develop/docs/CONTRIBUTING.en.md
|
||||||
- fix / refactor / feat / enhance / perf / chore
|
|
||||||
- Also, make sure that the granularity of this PR is appropriate. Please do not include more than one type of change or interest in a single PR.
|
|
||||||
- If there is an Issue which will be resolved by this PR, please include a reference to the Issue in the text.
|
|
||||||
- Please add the summary of the changes to CHANGELOG.md. However, this is not necessary for changes that do not affect the users, such as refactoring.
|
|
||||||
- Check if there are any documents that need to be created or updated due to this change.
|
|
||||||
- If you have added a feature or fixed a bug, please add a test case if possible.
|
|
||||||
- Please make sure that tests and Lint are passed in advance.
|
|
||||||
- You can run it with `npm run test` and `npm run lint`.
|
|
||||||
- If this PR includes UI changes, please attach a screenshot in the text.
|
|
||||||
Thanks for your cooperation 🤗
|
|
||||||
|
|
||||||
Important: If your language is not Japanese, you do not need to translate and write the description in Japanese.
|
|
||||||
The accuracy of translation into Japanese is not high, so it will be easier for us to understand if you write it in the original language.
|
|
||||||
It will also allow the reader to use the translation tool of their preference if necessary.
|
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# What
|
# What
|
||||||
|
|
|
||||||
|
|
@ -1,17 +1,35 @@
|
||||||
# Contribution guide
|
# Contribution guide
|
||||||
:v: Thanks for your contributions :v:
|
**[✨ English version available](/docs/CONTRIBUTING.en.md)**
|
||||||
|
|
||||||
## When you contribute...
|
プロジェクトに興味を持っていただきありがとうございます！ このドキュメントでは、プロジェクトに貢献する際に必要な情報をまとめています。
|
||||||
- 任意のIssueについて、せっかく実装してくださっても、実装方法や設計の認識が揃ってないとマージできない/しないことになりかねないので、初めにそのIssue上で着手することを宣言し、必要に応じて他メンバーと実装方法や設計のすり合わせを行ってください。宣言することは作業が他の人と被るのを防止する効果もあります。
|
|
||||||
- 設計に迷った時はプロジェクトリーダーの判断を仰いでください。
|
## 実装をする前に
|
||||||
- 時間や優先度の都合上、提出してくださったPRが長期間放置されることもありますがご理解ください。
|
機能追加やバグ修正をしたいときは、まずIssueなどで設計、方針をレビューしてもらいましょう(無い場合は作ってください)。このステップがないと、せっかく実装してもPRがマージされない可能性が高くなります。
|
||||||
- 温度感高めで見てほしいものは責付いてください。
|
|
||||||
|
また、実装に取り掛かるときは当該Issueに自分をアサインしてください(自分でできない場合は他メンバーに自分をアサインしてもらうようお願いしてください)。
|
||||||
|
自分が実装するという意思表示をすることで、作業がバッティングするのを防ぎます。
|
||||||
|
|
||||||
## Issues
|
## Issues
|
||||||
Feature suggestions and bug reports are filed in https://github.com/misskey-dev/misskey/issues .
|
Issueを作成する前に、以下をご確認ください:
|
||||||
|
- 重複を防ぐため、既に同様の内容のIssueが作成されていないか検索してから新しいIssueを作ってください。
|
||||||
|
- Issueを質問に使わないでください。
|
||||||
|
- Issueは、要望、提案、問題の報告にのみ使用してください。
|
||||||
|
- 質問は、[Misskey Forum](https://forum.misskey.io/)や[Discord](https://discord.gg/Wp8gVStHW3)でお願いします。
|
||||||
|
|
||||||
* Please search existing issues to avoid duplication. If your issue is already filed, please add your reaction or comment to the existing one.
|
## PRの作成
|
||||||
* If you have multiple independent issues, please submit them separately.
|
PRありがとうございます！ PRを作成する前に、以下をご確認ください:
|
||||||
|
- 可能であればタイトルに、以下で示すようなPRの種類が分かるキーワードをプリフィクスしてください。
|
||||||
|
- fix / refactor / feat / enhance / perf / chore
|
||||||
|
- また、PRの粒度が適切であることを確認してください。ひとつのPRに複数の種類の変更や関心を含めることは避けてください。
|
||||||
|
- このPRによって解決されるIssueがある場合は、そのIssueへの参照を本文内に含めてください。
|
||||||
|
- [`CHANGELOG.md`](/CHANGELOG.md)に変更点を追記してください。リファクタリングなど、利用者に影響を与えない変更についてはこの限りではありません。
|
||||||
|
- この変更により新たに作成、もしくは更新すべきドキュメントがないか確認してください。
|
||||||
|
- 機能追加やバグ修正をした場合は、可能であればテストケースを追加してください。
|
||||||
|
- テスト、Lintが通っていることを予め確認してください。
|
||||||
|
- `npm run test`、`npm run lint`でぞれぞれ実施可能です
|
||||||
|
- UIに変更がある場合はスクリーンショットを本文内に添付してください。
|
||||||
|
|
||||||
|
ご協力ありがとうございます🤗
|
||||||
|
|
||||||
## Branches
|
## Branches
|
||||||
* **master** branch is tracking the latest release and used for production purposes.
|
* **master** branch is tracking the latest release and used for production purposes.
|
||||||
|
|
|
||||||
29
docs/CONTRIBUTING.en.md
Normal file
29
docs/CONTRIBUTING.en.md
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
# Contribution guide
|
||||||
|
:v: Thanks for your contributions :v:
|
||||||
|
|
||||||
|
**ℹ️ Important:** This project uses Japanese as its major language, **but you do not need to translate and write the Issues/PRs in Japanese.**
|
||||||
|
Also, you might receive comments on your Issue/PR in Japanese, but you do not need to reply to them in Japanese as well.\
|
||||||
|
The accuracy of translation into Japanese is not high, so it will be easier for us to understand if you write it in the original language.
|
||||||
|
It will also allow the reader to use the translation tool of their preference if necessary.
|
||||||
|
|
||||||
|
## Issues
|
||||||
|
Before creating an issue, please check the following:
|
||||||
|
- To avoid duplication, please search for similar issues before creating a new issue.
|
||||||
|
- Do not use Issues as a question.
|
||||||
|
- Issues should only be used to feature requests, suggestions, and report problems.
|
||||||
|
- Please ask questions in the [Misskey Forum](https://forum.misskey.io/) or [Discord](https://discord.gg/Wp8gVStHW3).
|
||||||
|
|
||||||
|
## Creating a PR
|
||||||
|
Thank you for your PR! Before creating a PR, please check the following:
|
||||||
|
- If possible, prefix the title with a keyword that identifies the type of this PR, as shown below.
|
||||||
|
- fix / refactor / feat / enhance / perf / chore
|
||||||
|
- Also, make sure that the granularity of this PR is appropriate. Please do not include more than one type of change or interest in a single PR.
|
||||||
|
- If there is an Issue which will be resolved by this PR, please include a reference to the Issue in the text.
|
||||||
|
- Please add the summary of the changes to [`CHANGELOG.md`](/CHANGELOG.md). However, this is not necessary for changes that do not affect the users, such as refactoring.
|
||||||
|
- Check if there are any documents that need to be created or updated due to this change.
|
||||||
|
- If you have added a feature or fixed a bug, please add a test case if possible.
|
||||||
|
- Please make sure that tests and Lint are passed in advance.
|
||||||
|
- You can run it with `npm run test` and `npm run lint`.
|
||||||
|
- If this PR includes UI changes, please attach a screenshot in the text.
|
||||||
|
|
||||||
|
Thanks for your cooperation 🤗
|
||||||
Loading…
Add table
Add a link
Reference in a new issue