amechama/sharkey
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
e210ec782a
sharkey/docs/CONTRIBUTING.en.md
syuilo e210ec782a
Update CONTRIBUTING.en.md
2021-08-30 19:53:51 +09:00

2.5 KiB
Raw Blame History

Contribution guide

✌️ Thanks for your contributions ✌️

ℹ️ 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 or Discord.

Before implementation

When you want to add a feature or fix a bug, first have the design and policy reviewed in an Issue (if it is not there, please make one). Without this step, there is a high possibility that the PR will not be merged even if it is implemented.

Also, when you start implementation, assign yourself to the Issue (if you cannot do it yourself, ask another member to assign you). By expressing your intention to work the Issue, you can prevent conflicts in the work.

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. 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 🤗