Forked from
TransFem.org / Sharkey
15126 commits behind the upstream repository.
-
syuilo authoredUnverifiedefe530cb
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
After you've reviewed these contribution guidelines, you'll be all set to
contribute to this project.
CONTRIBUTING.md 1.75 KiB
Contribution guide
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
Use semicolon
To avoid ASI Hazard
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