diff options
| author | Kagami Sascha Rosylight <saschanaz@outlook.com> | 2023-03-30 02:33:19 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-30 09:33:19 +0900 |
| commit | cee1d5e2d01359e6d762a10fc67d4e7c1cc830eb (patch) | |
| tree | 45eab3096b1983ae5267caab4aa4c5eff77b6e5d /packages/misskey-js/docs | |
| parent | New Crowdin updates (#10407) (diff) | |
| download | misskey-cee1d5e2d01359e6d762a10fc67d4e7c1cc830eb.tar.gz misskey-cee1d5e2d01359e6d762a10fc67d4e7c1cc830eb.tar.bz2 misskey-cee1d5e2d01359e6d762a10fc67d4e7c1cc830eb.zip | |
chore: integrate misskey-js as a workspace item (git subtree) (#10409)
* Additional changes for the merge
* api-misskey-js
Diffstat (limited to 'packages/misskey-js/docs')
| -rw-r--r-- | packages/misskey-js/docs/CONTRIBUTING.en.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/packages/misskey-js/docs/CONTRIBUTING.en.md b/packages/misskey-js/docs/CONTRIBUTING.en.md new file mode 100644 index 0000000000..1db282e356 --- /dev/null +++ b/packages/misskey-js/docs/CONTRIBUTING.en.md @@ -0,0 +1,30 @@ +# 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 etc. + - 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`. +- Run `npm run api` to update the API report and commit it if there are any diffs. + +Thanks for your cooperation 🤗 + |