2017-03-30 19:11:38 +03:00
|
|
|
# Contribution guide
|
2018-09-01 12:02:04 +03:00
|
|
|
:v: Thanks for your contributions :v:
|
2017-03-26 15:32:19 +03:00
|
|
|
|
2018-09-01 12:02:04 +03:00
|
|
|
## Issues
|
|
|
|
|
Feature suggestions and bug reports are filed in https://github.com/syuilo/misskey/issues .
|
|
|
|
|
Before creating a new issue, please search existing issues to avoid duplication.
|
|
|
|
|
If you find the existing issue, please add your reaction or comment to the issue.
|
2017-03-26 15:32:19 +03:00
|
|
|
|
2018-09-01 12:02:04 +03:00
|
|
|
## Localization (l10n)
|
2018-09-01 12:15:25 +03:00
|
|
|
Please use [Crowdin](https://crowdin.com/project/misskey) for localization.
|
2017-03-26 15:32:19 +03:00
|
|
|
|
2018-09-01 12:15:25 +03:00
|
|
|
|
2017-03-26 15:32:19 +03:00
|
|
|
|
2018-11-09 17:47:36 +02:00
|
|
|
## Internationalization (i18n)
|
|
|
|
|
Misskey uses [vue-i18n](https://github.com/kazupon/vue-i18n).
|
|
|
|
|
|
2018-09-01 12:02:04 +03:00
|
|
|
## Documentation
|
|
|
|
|
* Documents for contributors are located in `/docs`.
|
|
|
|
|
* Documents for instance admins are located in `/docs`.
|
|
|
|
|
* Documents for end users are located in `src/docs`.
|
2017-03-26 15:32:19 +03:00
|
|
|
|
2018-09-01 12:02:04 +03:00
|
|
|
## Test
|
|
|
|
|
* Test codes are located in `/test`.
|
|
|
|
|
|
|
|
|
|
## Continuous integration
|
2018-11-05 03:52:07 +02:00
|
|
|
Misskey uses CircleCI for automated test.
|
|
|
|
|
Configuration files are located in `/.circleci`.
|
2018-12-19 20:01:02 +02:00
|
|
|
|
|
|
|
|
## Glossary
|
|
|
|
|
### AP
|
2018-12-19 20:02:19 +02:00
|
|
|
Stands for _**A**ctivity**P**ub_.
|
2018-12-19 20:01:02 +02:00
|
|
|
|
|
|
|
|
### MFM
|
2018-12-19 20:02:19 +02:00
|
|
|
Stands for _**M**isskey **F**lavored **M**arkdown_.
|
2018-12-19 20:01:02 +02:00
|
|
|
|
|
|
|
|
### Mk
|
2018-12-19 20:02:19 +02:00
|
|
|
Stands for _**M**iss**k**ey_.
|
2018-12-19 20:44:19 +02:00
|
|
|
|
|
|
|
|
### SW
|
|
|
|
|
Stands for _**S**ervice**W**orker_.
|
2019-01-24 12:52:00 +02:00
|
|
|
|
|
|
|
|
### Nyaize
|
|
|
|
|
な を にゃ にすること
|
|
|
|
|
|
|
|
|
|
#### Denyaize
|
|
|
|
|
Nyaizeを解除すること
|
2019-02-07 07:54:14 +02:00
|
|
|
|
|
|
|
|
## Code style
|
|
|
|
|
### Don't use `export default`
|
|
|
|
|
Bad:
|
|
|
|
|
``` ts
|
|
|
|
|
export default function(foo: string): string {
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Good:
|
|
|
|
|
``` ts
|
|
|
|
|
export function something(foo: string): string {
|
|
|
|
|
```
|
2019-02-07 21:08:25 +02:00
|
|
|
|
|
|
|
|
## Directory structure
|
|
|
|
|
```
|
|
|
|
|
src ... ソースコード
|
2019-02-07 21:33:15 +02:00
|
|
|
@types ... 外部ライブラリなどの型定義
|
2019-02-07 21:08:25 +02:00
|
|
|
prelude ... Misskeyに関係ないかつ副作用なし
|
|
|
|
|
misc ... 副作用なしのユーティリティ処理
|
|
|
|
|
service ... 副作用ありの共通処理
|
|
|
|
|
queue ... ジョブキューとジョブ
|
|
|
|
|
server ... Webサーバー
|
|
|
|
|
client ... クライアント
|
|
|
|
|
mfm ... MFM
|
|
|
|
|
|
|
|
|
|
test ... テスト
|
|
|
|
|
|
|
|
|
|
```
|
