Sharkey/CONTRIBUTING.md

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

な を にゃ にすること

Denyaize

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 ... ソースコード
	@types ... 外部ライブラリなどの型定義
	prelude ... Misskeyに関係ないかつ副作用なし
	misc ... 副作用なしのユーティリティ処理
	service ... 副作用ありの共通処理
	queue ... ジョブキューとジョブ
	server ... Webサーバー
	client ... クライアント
	mfm ... MFM

test ... テスト