summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAya Morisawa <AyaMorisawa4869@gmail.com>2019-07-22 14:57:23 +0900
committerGitHub <noreply@github.com>2019-07-22 14:57:23 +0900
commit636f90ca0c61fa4fa57d38934826f0c8386f36f6 (patch)
treeb097cf149ab4143fb94b5338c2d94cb6bf9d5536 /CONTRIBUTING.md
parentBetter error (diff)
downloadsharkey-636f90ca0c61fa4fa57d38934826f0c8386f36f6.tar.gz
sharkey-636f90ca0c61fa4fa57d38934826f0c8386f36f6.tar.bz2
sharkey-636f90ca0c61fa4fa57d38934826f0c8386f36f6.zip
Improve CONTRIBUTING.md (#5158)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 548c76910b..ba45f5d23c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -7,12 +7,18 @@ Feature suggestions and bug reports are filed in https://github.com/syuilo/missk
* Please search existing issues to avoid duplication. If your issue is already filed, please add your reaction or comment to the existing one.
* If you have multiple independent issues, please submit them separately.
+## Branches
+* **master** branch is tracking the latest release and used for production purposes.
+* **develop** branch is where we work for the next release.
+* **l10n_develop** branch is reserved for localization management.
+
## Localization (l10n)
Misskey uses [Crowdin](https://crowdin.com/project/misskey) for localization management.
You can improve our translations with your Crowdin account.
-Changes you make in Crowdin will be merged into the develop branch by @syuilo.
+Your changes in Crowdin are automatically submitted as a PR (with the title "New Crowdin translations") to the repository.
+The owner [@syuilo](https://github.com/syuilo) merges the PR into the develop branch before the next release.
-If you cannot find the language you want to contribute with, please open an issue.
+If your language is not listed in Crowdin, please open an issue.
![Crowdin](https://d322cqt584bo4o.cloudfront.net/misskey/localized.svg)
@@ -33,7 +39,6 @@ Misskey uses CircleCI for executing automated tests.
Configuration files are located in [`/.circleci`](/.circleci).
## FAQ
-
### How to resolve conflictions occurred at yarn.lock?
Just execute `yarn` to fix it.
@@ -93,6 +98,8 @@ Good:
if (foo) bar;
```
+Make sure that the condition and the body statement are on the same line.
+
### Do not use `==` when it can simply be replaced with `===`.
🥰