Sharkey/CONTRIBUTING.md

75 lines
1.7 KiB
Markdown
Raw Normal View History

2017-03-30 16:11:38 +00:00
# Contribution guide
2018-09-01 09:02:04 +00:00
:v: Thanks for your contributions :v:
2017-03-26 12:32:19 +00:00
2018-09-01 09:02:04 +00: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 12:32:19 +00:00
2018-09-01 09:02:04 +00:00
## Localization (l10n)
2018-09-01 09:15:25 +00:00
Please use [Crowdin](https://crowdin.com/project/misskey) for localization.
2017-03-26 12:32:19 +00:00
2018-09-01 09:15:25 +00:00
![Crowdin](https://d322cqt584bo4o.cloudfront.net/misskey/localized.svg)
2017-03-26 12:32:19 +00:00
2018-11-09 15:47:36 +00:00
## Internationalization (i18n)
Misskey uses [vue-i18n](https://github.com/kazupon/vue-i18n).
2018-09-01 09:02:04 +00: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 12:32:19 +00:00
2018-09-01 09:02:04 +00:00
## Test
* Test codes are located in `/test`.
## Continuous integration
2018-11-05 01:52:07 +00:00
Misskey uses CircleCI for automated test.
Configuration files are located in `/.circleci`.
2018-12-19 18:01:02 +00:00
## Glossary
### AP
2018-12-19 18:02:19 +00:00
Stands for _**A**ctivity**P**ub_.
2018-12-19 18:01:02 +00:00
### MFM
2018-12-19 18:02:19 +00:00
Stands for _**M**isskey **F**lavored **M**arkdown_.
2018-12-19 18:01:02 +00:00
### Mk
2018-12-19 18:02:19 +00:00
Stands for _**M**iss**k**ey_.
2018-12-19 18:44:19 +00:00
### SW
Stands for _**S**ervice**W**orker_.
2019-01-24 10:52:00 +00:00
### Nyaize
Convert な(na) to にゃ(nya)
2019-01-24 10:52:00 +00:00
#### Denyaize
Revert Nyaize
2019-02-07 05:54:14 +00: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 19:08:25 +00:00
## Directory structure
```
src ... Source code
@types ... Type definitions
prelude ... Independence utils for coding JavaScript without side effects
misc ... Independence utils for Misskey without side effects
service ... Common functions with side effects
queue ... Job queues and Jobs
server ... Web Server
client ... Client
2019-02-07 19:08:25 +00:00
mfm ... MFM
test ... Test code
2019-02-07 19:08:25 +00:00
```