mirror of
https://github.com/misskey-dev/misskey.git
synced 2024-12-24 00:39:32 +09:00
010d3f8281
* Update translationa about Nyaize * Update translation about description of source code * Fix translation
1.7 KiB
1.7 KiB
Contribution guide
✌️ Thanks for your contributions ✌️
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.
Localization (l10n)
Please use Crowdin for localization.
Internationalization (i18n)
Misskey uses vue-i18n.
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
.
Test
- Test codes are located in
/test
.
Continuous integration
Misskey uses CircleCI for automated test.
Configuration files are located in /.circleci
.
Glossary
AP
Stands for ActivityPub.
MFM
Stands for Misskey Flavored Markdown.
Mk
Stands for Misskey.
SW
Stands for ServiceWorker.
Nyaize
Convert な(na) to にゃ(nya)
Denyaize
Revert Nyaize
Code style
Don't use export default
Bad:
export default function(foo: string): string {
Good:
export function something(foo: string): string {
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
mfm ... MFM
test ... Test code