naskya/firefish

Fork 1

mirror of https://example.com synced 2024-11-24 23:06:38 +09:00

syuilo ba474648a2

Update CONTRIBUTING.md

2019-09-08 21:21:08 +09:00

8.7 KiB

Raw Blame History

Contribution guide

✌️ Thanks for your contributions ✌️

Issues

Feature suggestions and bug reports are filed in https://github.com/syuilo/misskey/issues .

Please search existing issues to avoid duplication. If your issue is already filed, please add your reaction or comment to the existing one.
If you have multiple independent issues, please submit them separately.

Branches

master branch is tracking the latest release and used for production purposes.
develop branch is where we work for the next release.
l10n_develop branch is reserved for localization management.

Localization (l10n)

Misskey uses Crowdin for localization management. You can improve our translations with your Crowdin account. Your changes in Crowdin are automatically submitted as a PR (with the title "New Crowdin translations") to the repository. The owner @syuilo merges the PR into the develop branch before the next release.

If your language is not listed in Crowdin, please open an issue.

Internationalization (i18n)

Misskey uses the Vue.js plugin Vue I18n. Documentation of Vue I18n is available at http://kazupon.github.io/vue-i18n/introduction.html .

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 executing automated tests. Configuration files are located in /.circleci.

Adding MisskeyRoom items

Use English for material, object and texture names.
Use meter for unit of length.
Your PR should include all source files (e.g. .png, .blend) of your models (for later editing).
Your PR must include the glTF binary files (.glb) of your models.
Add a locale key room.furnitures.YOUR_ITEM at /locales/ja-JP.yml.
Add a furniture definition at /src/client/app/common/scripts/room/furnitures.json5.

If you have no experience on 3D modeling, we suggest to use the free 3DCG software Blender. You can find information on glTF 2.0 at glTF 2.0 — Blender Manual.

FAQ

How to resolve conflictions occurred at yarn.lock?

Just execute yarn to fix it.

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

TypeScript Coding Style

Do not omit semicolons

This is to avoid Automatic Semicolon Insertion (ASI) hazard.

Ref:

Do not omit curly brackets

Bad:

if (foo)
	bar;
else
	baz;

Good:

if (foo) {
	bar;
} else {
	baz;
}

As a special case, you can omit the curly brackets if

the body of the if-statement have only one statement and,
the if-statement does not have else-clause.

Good:

if (foo) bar;

Make sure that the condition and the body statement are on the same line.

Do not use `==` when it can simply be replaced with `===`.

🥰

Use only boolean (or null related) values in the condition of an `if`-statement.

Bad:

if (foo.length)

Good:

if (foo.length > 0)

Do not use `export default`

This is because the current language support does not work well with export default.

Ref:

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

Notes

placeholder

SQLをクエリビルダで組み立てる際、使用するプレースホルダは重複してはならない例えば

query.andWhere(new Brackets(qb => {
	for (const type of ps.fileType) {
		qb.orWhere(`:type = ANY(note.attachedFileTypes)`, { type: type });
	}
}));

と書くと、ループ中でtypeというプレースホルダが複数回使われてしまいおかしくなるだから次のようにする必要がある

query.andWhere(new Brackets(qb => {
	for (const type of ps.fileType) {
		const i = ps.fileType.indexOf(type);
		qb.orWhere(`:type${i} = ANY(note.attachedFileTypes)`, { [`type${i}`]: type });
	}
}));

Not `null` in TypeORM

const foo = await Foos.findOne({
	bar: Not(null)
});

のようなクエリ(barがnullではない)は期待通りに動作しない。次のようにします:

const foo = await Foos.findOne({
	bar: Not(IsNull())
});

`null` in SQL

SQLを発行する際、パラメータがnullになる可能性のある場合はSQL文を出し分けなければならない例えば

query.where('file.folderId = :folderId', { folderId: ps.folderId });

という処理で、ps.folderIdがnullだと結果的にfile.folderId = nullのようなクエリが発行されてしまい、これは正しいSQLではないので期待した結果が得られないだから次のようにする必要がある

if (ps.folderId) {
	query.where('file.folderId = :folderId', { folderId: ps.folderId });
} else {
	query.where('file.folderId IS NULL');
}

`[]` in SQL

SQLを発行する際、INのパラメータが[](空の配列)になる可能性のある場合はSQL文を出し分けなければならない例えば

const users = await Users.find({
	id: In(userIds)
});

という処理で、userIdsが[]だと結果的にuser.id IN ()のようなクエリが発行されてしまい、これは正しいSQLではないので期待した結果が得られないだから次のようにする必要がある

const users = userIds.length > 0 ? await Users.find({
	id: In(userIds)
}) : [];

配列のインデックス in SQL

SQLでは配列のインデックスは1始まり。 [a, b, c]の aにアクセスしたいなら[0]ではなく[1]と書く

`undefined`にご用心

MongoDBの時とは違い、findOneでレコードを取得する時に対象レコードが存在しない場合 undefined が返ってくるので注意。 MongoDBはnullで返してきてたので、その感覚でif (x === null)とか書くとバグる。代わりにif (x == null)と書いてください

簡素な`undefined`チェック

データベースからレコードを取得するときに、プログラムの流れ的に(ほぼ)絶対undefinedにはならない場合でも、undefinedチェックしないとTypeScriptに怒られます。でもいちいち複数行を費やして、発生するはずのないundefinedをチェックするのも面倒なので、ensureというユーティリティ関数を用意しています。例えば、

const user = await Users.findOne(userId);
// この時点で user の型は User | undefined
if (user == null) {
	throw 'missing user';
}
// この時点で user の型は User

という処理をensureを使うと

const user = await Users.findOne(userId).then(ensure);
// この時点で user の型は User

という風に書けます。もちろんensure内部でエラーを握りつぶすようなことはしておらず、万が一undefinedだった場合はPromiseがRejectされ後続の処理は実行されません。

const user = await Users.findOne(userId).then(ensure);
// 万が一 Users.findOne の結果が undefined だったら、ensure でエラーが発生するので
// この行に到達することは無い
// なので、.then(ensure) は
// if (user == null) {
//	throw 'missing user';
// }
// の糖衣構文のような扱いです

Migration作成方法

npx ts-node ./node_modules/typeorm/cli.js migration:generate -n 変更の名前

作成されたスクリプトは不必要な変更を含むため除去してください。

その他

HTMLのクラス名で follow という単語は使わない

広告ブロッカーで誤ってブロックされる

8.7 KiB Raw Blame History

Contribution guide

Issues

Branches

Localization (l10n)

Internationalization (i18n)

Documentation

Test

Continuous integration

Adding MisskeyRoom items

FAQ

How to resolve conflictions occurred at yarn.lock?

Glossary

AP

MFM

Mk

SW

Nyaize

Denyaize

TypeScript Coding Style

Do not omit semicolons

Do not omit curly brackets

Do not use == when it can simply be replaced with ===.

Use only boolean (or null related) values in the condition of an if-statement.

Do not use export default

Directory structure

Notes

placeholder

Not null in TypeORM

null in SQL

[] in SQL

配列のインデックス in SQL

undefinedにご用心

簡素なundefinedチェック

Migration作成方法

その他

HTMLのクラス名で follow という単語は使わない

8.7 KiB

Raw Blame History

Do not use `==` when it can simply be replaced with `===`.

Use only boolean (or null related) values in the condition of an `if`-statement.

Do not use `export default`

Not `null` in TypeORM

`null` in SQL

`[]` in SQL

`undefined`にご用心

簡素な`undefined`チェック