Merge remote-tracking branch 'misskey/master' into feature/misskey-2024.07

2025-12-20 04:04:16 +00:00 · 2024-08-02 12:25:58 +01:00
parent ad9848acfa e98f66db51
commit cfa9b852df
585 changed files with 23423 additions and 9623 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -11,10 +11,12 @@ Before creating an issue, please check the following:
 	- Issues should only be used to feature requests, suggestions, and bug tracking.
 	- Please ask questions or troubleshooting in [Discord](https://discord.gg/6VgKmEqHNk).

-> **Warning**
+> [!WARNING]
 > Do not close issues that are about to be resolved. It should remain open until a commit that actually resolves it is merged.

-## Before implementation
+### Recommended discussing before implementation
+We welcome your proposal.
+
 When you want to add a feature or fix a bug, *please open an issue*,
 don't just start writing code. We may suggest different approaches, or
 show that the "bug" is actually intended behaviour (and offer
@@ -25,7 +27,20 @@ Misskey. Each of these examples have actually happened!
 On the other hand, it's very likely that we'll tell you "go
 ahead!". We try our best to incorporate improvements from our users!

-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.
+Also, when you start implementation, assign yourself to the Issue (if you cannot do it yourself, ask Committer to assign you).
+By expressing your intention to work on the Issue, you can prevent conflicts in the work.
+
+To the Committers: you should not assign someone on it before the Final Decision.
+
+### How issues are triaged
+
+The Committers may:
+* close an issue that is not reproducible on latest stable release,
+* merge an issue into another issue,
+* split an issue into multiple issues,
+* or re-open that has been closed for some reason which is not applicable anymore.
+
+@syuilo reserves the Final Decision rights including whether the project will implement feature and how to implement, these rights are not always exercised.

 ## Well-known branches
 - **`stable`** branch is tracking the latest release and used for production purposes.
@@ -35,14 +50,14 @@ Also, when you start implementation, assign yourself to the Issue (if you cannot
 ## 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.
+	- `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`](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 `pnpm test` and `pnpm lint`. [See more info](#testing)
+	- You can run it with `pnpm test` and `pnpm lint`. [See more info](#testing)
 - If this PR includes UI changes, please attach a screenshot in the text.

 Thanks for your cooperation 🤗
@@ -52,8 +67,8 @@ 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?
+	- Are the goals of the PR clear?
+	- Is the granularity of the PR appropriate?
 - Security
 	- Does merging this PR create a vulnerability?
 - Performance
@@ -68,7 +83,7 @@ Be willing to comment on the good points and not just the things you want fixed

 ## Release
 ### Release Instructions
-1. Commit version changes in the `develop` branch ([package.json](https://activitypub.software/TransFem-org/Sharkey/-/blob/develop/package.json))
+1. Commit version changes in the `develop` branch ([package.json](package.json))
 2. Create a release PR.
 	- Into `stable` from `develop` branch.
 	- The title must be in the format `Release: x.y.z`.
@@ -79,7 +94,7 @@ Be willing to comment on the good points and not just the things you want fixed
 	- The target branch must be `stable`
 	- The tag name must be the version

-> **Note**
+> [!NOTE]
 > Why this instruction is necessary:
 > - To perform final QA checks
 > - To distribute responsibility
@@ -97,12 +112,42 @@ If your language is not listed in Crowdin, please open an issue.
 ![Crowdin](https://d322cqt584bo4o.cloudfront.net/misskey/localized.svg)

 ## Development
-During development, it is useful to use the
+### Setup
+Before developing, you have to set up environment. Misskey requires Redis, PostgreSQL, and FFmpeg.

+You would want to install Meilisearch to experiment related features. Technically, meilisearch is not strict requirement, but some features and tests require it.
+
+There are a few ways to proceed.
+
+#### Use system-wide software
+You could install them in system-wide (such as from package manager).
+
+#### Use `docker compose`
+You could obtain middleware container by typing `docker compose -f $PROJECT_ROOT/compose.local-db.yml up -d`.
+
+#### Use Devcontainer
+Devcontainer also has necessary setting. This method can be done by connecting from VSCode.
+
+Instead of running `pnpm` locally, you can use Dev Container to set up your development environment.
+To use Dev Container, open the project directory on VSCode with Dev Containers installed.
+**Note:** If you are using Windows, please clone the repository with WSL. Using Git for Windows will result in broken files due to the difference in how newlines are handled.
+
+It will run the following command automatically inside the container.
+``` bash
+git submodule update --init
+pnpm install --frozen-lockfile
+cp .devcontainer/devcontainer.yml .config/default.yml
+pnpm build
+pnpm migrate
+```
+
+After finishing the migration, you can proceed.
+
+### Start developing
+During development, it is useful to use the
 ```
 pnpm dev
 ```
-
 command.

 - Server-side source files and automatically builds them if they are modified. Automatically start the server process(es).
@@ -126,26 +171,6 @@ MK_DEV_PREFER=backend pnpm dev
 - To change the port of Vite, specify with `VITE_PORT` environment variable.
 - HMR may not work in some environments such as Windows.

-### Dev Container
-Instead of running `pnpm` locally, you can use Dev Container to set up your development environment.
-To use Dev Container, open the project directory on VSCode with Dev Containers installed.  
-**Note:** If you are using Windows, please clone the repository with WSL. Using Git for Windows will result in broken files due to the difference in how newlines are handled.
-
-It will run the following command automatically inside the container.
-``` bash
-git submodule update --init
-pnpm install --frozen-lockfile
-cp .devcontainer/devcontainer.yml .config/default.yml
-pnpm build
-pnpm migrate
-```
-
-After finishing the migration, run the `pnpm dev` command to start the development server.
-
-``` bash
-pnpm dev
-```
-
 ## Testing
 - Test codes are located in [`/packages/backend/test`](packages/backend/test).

@@ -156,7 +181,7 @@ cp .github/misskey/test.yml .config/
 ```
 Prepare DB/Redis for testing.
 ```
-docker compose -f packages/backend/test/docker-compose.yml up
+docker compose -f packages/backend/test/compose.yml up
 ```
 Alternatively, prepare an empty (data can be erased) DB and edit `.config/test.yml`.

@@ -195,7 +220,7 @@ niraxは、Misskeyで使用しているオリジナルのフロントエンド
 ### ルート定義
 ルート定義は、以下の形式のオブジェクトの配列です。

-``` ts
+```ts
 {
 	name?: string;
 	path: string;
@@ -208,7 +233,7 @@ niraxは、Misskeyで使用しているオリジナルのフロントエンド
 }
 ```

-> **Warning**
+> [!WARNING]
 > 現状、ルートは定義された順に評価されます。
 > たとえば、`/foo/:id`ルート定義の次に`/foo/bar`ルート定義がされていた場合、後者がマッチすることはありません。

@@ -270,7 +295,7 @@ export const Default = {
 	parameters: {
 		layout: 'centered',
 	},
-} satisfies StoryObj<typeof MkAvatar>;
+} satisfies StoryObj<typeof MyComponent>;
 ```

 If you want to opt-out from the automatic generation, create a `MyComponent.stories.impl.ts` file and add the following line to the file.
@@ -381,7 +406,7 @@ describe('test', () => {
 		})
 			.useMocker(...
 			.compile();
-	
+
 		fooService = app.get<FooService>(FooService);
 		barService = app.get<BarService>(BarService) as jest.Mocked<BarService>;

@@ -502,13 +527,13 @@ pnpm dlx typeorm migration:generate -d ormconfig.js -o <migration name>
 - 作成されたスクリプトは不必要な変更を含むため除去してください

 ### JSON SchemaのobjectでanyOfを使うとき
-JSON Schemaで、objectに対してanyOfを使う場合、anyOfの中でpropertiesを定義しないこと。  
-バリデーションが効かないため。（SchemaTypeもそのように作られており、objectのanyOf内のpropertiesは捨てられます）  
+JSON Schemaで、objectに対してanyOfを使う場合、anyOfの中でpropertiesを定義しないこと。
+バリデーションが効かないため。（SchemaTypeもそのように作られており、objectのanyOf内のpropertiesは捨てられます）
 https://github.com/misskey-dev/misskey/pull/10082

 テキストhogeおよびfugaについて、片方を必須としつつ両方の指定もありうる場合:

-```
+```ts
 export const paramDef = {
 	type: 'object',
 	properties: {