hippofish/CONTRIBUTING.md

Contribution guide

We're glad you're interested in contributing Misskey! In this document you will find the information you need to contribute to the project.

ℹ️ Important: This project uses Japanese as its major language, but you do not need to translate and write the Issues/PRs in Japanese. Also, you might receive comments on your Issue/PR in Japanese, but you do not need to reply to them in Japanese as well.
The accuracy of machine translation into Japanese is not high, so it will be easier for us to understand if you write it in the original language. It will also allow the reader to use the translation tool of their preference if necessary.

Issues

Before creating an issue, please check the following:

• To avoid duplication, please search for similar issues before creating a new issue.
• Do not use Issues to ask questions or troubleshooting.
  • Issues should only be used to feature requests, suggestions, and bug tracking.
  • Please ask questions or troubleshooting in the Misskey Forum or Discord.

Before implementation

When you want to add a feature or fix a bug, first have the design and policy reviewed in an Issue (if it is not there, please make one). Without this step, there is a high possibility that the PR will not be merged even if it is implemented.

At this point, you also need to clarify the goals of the PR you will create, and make sure that the other members of the team are aware of them. PRs that do not have a clear set of do's and don'ts tend to be bloated and difficult to review.

Also, when you start implementation, assign yourself to the Issue (if you cannot do it yourself, ask another member to assign you). By expressing your intention to work the Issue, you can prevent conflicts in the work.

Well-known branches

• master branch is tracking the latest release and used for production purposes.
• develop branch is where we work for the next release.
  • When you create a PR, basically target it to this branch.
• l10n_develop branch is reserved for localization management.

Creating a PR

Thank you for your PR! Before creating a PR, please check the following:

• If possible, prefix the title with a keyword that identifies the type of this PR, as shown below.
  • fix / refactor / feat / enhance / perf / chore etc
  • Also, make sure that the granularity of this PR is appropriate. Please do not include more than one type of change or interest in a single PR.
• If there is an Issue which will be resolved by this PR, please include a reference to the Issue in the text.
• Please add the summary of the changes to CHANGELOG.md. However, this is not necessary for changes that do not affect the users, such as refactoring.
• Check if there are any documents that need to be created or updated due to this change.
• If you have added a feature or fixed a bug, please add a test case if possible.
• Please make sure that tests and Lint are passed in advance.
  • You can run it with npm run test and npm run lint. See more info
• If this PR includes UI changes, please attach a screenshot in the text.

Thanks for your cooperation 🤗

Reviewers guide

Be willing to comment on the good points and not just the things you want fixed 💯

Review perspective

• Scope
  • Are the goals of the PR clear?
  • Is the granularity of the PR appropriate?
• Security
  • Does merging this PR create a vulnerability?
• Performance
  • Will merging this PR cause unexpected performance degradation?
  • Is there a more efficient way?
• Testing
  • Does the test ensure the expected behavior?
  • Are there any omissions or gaps?
  • Does it check for anomalies?

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.

Development

During development, it is useful to use the npm run dev command. This command monitors the server-side and client-side source files and automatically builds them if they are modified. In addition, it will also automatically start the Misskey server process.

Testing

• Test codes are located in /test.

Run test

Create a config file.

cp test/test.yml .config/

Prepare DB/Redis for testing.

docker-compose -f test/docker-compose.yml up

Alternatively, prepare an empty (data can be erased) DB and edit .config/test.yml.

Run all test.

npm run test

Run specify test

npx cross-env TS_NODE_FILES=true TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT="./test/tsconfig.json" npx mocha test/foo.ts --require ts-node/register

e2e tests

TODO

Continuous integration

Misskey uses GitHub Actions for executing automated tests. Configuration files are located in /.github/workflows.

Vue

Misskey uses Vue(v3) as its front-end framework.

• Use TypeScript.
• When creating a new component, please use the Composition API (with setup sugar and ref sugar) instead of the Options API.
  • Some of the existing components are implemented in the Options API, but it is an old implementation. Refactors that migrate those components to the Composition API are also welcome.

Notes

How to resolve conflictions occurred at yarn.lock?

Just execute yarn to fix it.

INSERTするときにはsaveではなくinsertを使用する

#6441

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]と書く

null IN

nullが含まれる可能性のあるカラムにINするときは、そのままだとおかしくなるのでORなどでnullのハンドリングをしよう。

undefinedにご用心

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

Migration作成方法

packages/backendで:

npx typeorm migration:generate -d ormconfig.js -o <migration name>

• 生成後、ファイルをmigration下に移してください
• 作成されたスクリプトは不必要な変更を含むため除去してください

コネクションにはmarkRawせよ

Vueのコンポーネントのdataオプションとしてmisskey.jsのコネクションを設定するとき、必ずmarkRawでラップしてください。インスタンスが不必要にリアクティブ化されることで、misskey.js内の処理で不具合が発生するとともに、パフォーマンス上の問題にも繋がる。なお、Composition APIを使う場合はこの限りではない(リアクティブ化はマニュアルなため)。

JSONのimportに気を付けよう

TypeScriptでjsonをimportすると、tscでコンパイルするときにそのjsonファイルも一緒にdistディレクトリに吐き出されてしまう。この挙動により、意図せずファイルの書き換えが発生することがあるので、jsonをimportするときは書き換えられても良いものかどうか確認すること。書き換えされて欲しくない場合は、importで読み込むのではなく、fs.readFileSyncなどの関数を使って読み込むようにすればよい。

コンポーネントのスタイル定義でmarginを持たせない

コンポーネント自身がmarginを設定するのは問題の元となることはよく知られている marginはそのコンポーネントを使う側が設定する

その他

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

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