Skip to content

Commit 0d76842

Browse files
authored
docs: format CONTRIBUTING.md (#14302)
* fix: correct typos * chore: convert indentation to tabs * fix: missing lang * chore: trim unnecessary whitespaces and newlines * chore: use local path * chore: use GFM alerts * fix: missing use GFM alerts
1 parent 908d3ec commit 0d76842

File tree

1 file changed

+21
-24
lines changed

1 file changed

+21
-24
lines changed

CONTRIBUTING.md

+21-24
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Contribution guide
22
We're glad you're interested in contributing Misskey! In this document you will find the information you need to contribute to the project.
33

4-
> **Note**
4+
> [!NOTE]
55
> This project uses Japanese as its major language, **but you do not need to translate and write the Issues/PRs in Japanese.**
66
> Also, you might receive comments on your Issue/PR in Japanese, but you do not need to reply to them in Japanese as well.\
77
> 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.
@@ -17,32 +17,31 @@ Before creating an issue, please check the following:
1717
- Issues should only be used to feature requests, suggestions, and bug tracking.
1818
- Please ask questions or troubleshooting in [GitHub Discussions](https://github.com/misskey-dev/misskey/discussions) or [Discord](https://discord.gg/Wp8gVStHW3).
1919

20-
> **Warning**
20+
> [!WARNING]
2121
> Do not close issues that are about to be resolved. It should remain open until a commit that actually resolves it is merged.
2222
23-
2423
### Recommended discussing before implementation
25-
We welcome your purposal.
24+
We welcome your proposal.
2625

2726
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.
2827

2928
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.
3029
PRs that do not have a clear set of do's and don'ts tend to be bloated and difficult to review.
3130

32-
Also, when you start implementation, assign yourself to the Issue (if you cannot do it yourself, ask Commiter to assign you).
31+
Also, when you start implementation, assign yourself to the Issue (if you cannot do it yourself, ask Committer to assign you).
3332
By expressing your intention to work on the Issue, you can prevent conflicts in the work.
3433

3534
To the Committers: you should not assign someone on it before the Final Decision.
3635

3736
### How issues are triaged
3837

39-
The Commiters may:
38+
The Committers may:
4039
* close an issue that is not reproducible on latest stable release,
4140
* merge an issue into another issue,
4241
* split an issue into multiple issues,
4342
* or re-open that has been closed for some reason which is not applicable anymore.
4443

45-
@syuilo reserves the Final Desicion rights including whether the project will implement feature and how to implement, these rights are not always exercised.
44+
@syuilo reserves the Final Decision rights including whether the project will implement feature and how to implement, these rights are not always exercised.
4645

4746
## Well-known branches
4847
- **`master`** branch is tracking the latest release and used for production purposes.
@@ -53,14 +52,14 @@ The Commiters may:
5352
## Creating a PR
5453
Thank you for your PR! Before creating a PR, please check the following:
5554
- If possible, prefix the title with a keyword that identifies the type of this PR, as shown below.
56-
- `fix` / `refactor` / `feat` / `enhance` / `perf` / `chore` etc
57-
- 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.
55+
- `fix` / `refactor` / `feat` / `enhance` / `perf` / `chore` etc
56+
- 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.
5857
- If there is an Issue which will be resolved by this PR, please include a reference to the Issue in the text.
5958
- 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.
6059
- Check if there are any documents that need to be created or updated due to this change.
6160
- If you have added a feature or fixed a bug, please add a test case if possible.
6261
- Please make sure that tests and Lint are passed in advance.
63-
- You can run it with `pnpm test` and `pnpm lint`. [See more info](#testing)
62+
- You can run it with `pnpm test` and `pnpm lint`. [See more info](#testing)
6463
- If this PR includes UI changes, please attach a screenshot in the text.
6564

6665
Thanks for your cooperation 🤗
@@ -70,8 +69,8 @@ Be willing to comment on the good points and not just the things you want fixed
7069

7170
### Review perspective
7271
- Scope
73-
- Are the goals of the PR clear?
74-
- Is the granularity of the PR appropriate?
72+
- Are the goals of the PR clear?
73+
- Is the granularity of the PR appropriate?
7574
- Security
7675
- Does merging this PR create a vulnerability?
7776
- Performance
@@ -93,7 +92,7 @@ An actual domain will be assigned so you can test the federation.
9392

9493
## Release
9594
### Release Instructions
96-
1. Commit version changes in the `develop` branch ([package.json](https://github.com/misskey-dev/misskey/blob/develop/package.json))
95+
1. Commit version changes in the `develop` branch ([package.json](package.json))
9796
2. Create a release PR.
9897
- Into `master` from `develop` branch.
9998
- The title must be in the format `Release: x.y.z`.
@@ -104,7 +103,7 @@ An actual domain will be assigned so you can test the federation.
104103
- The target branch must be `master`
105104
- The tag name must be the version
106105

107-
> **Note**
106+
> [!NOTE]
108107
> Why this instruction is necessary:
109108
> - To perform final QA checks
110109
> - To distribute responsibility
@@ -139,7 +138,7 @@ You could obtain middleware container by typing `docker compose -f $PROJECT_ROOT
139138
Devcontainer also has necessary setting. This method can be done by connecting from VSCode.
140139

141140
Instead of running `pnpm` locally, you can use Dev Container to set up your development environment.
142-
To use Dev Container, open the project directory on VSCode with Dev Containers installed.
141+
To use Dev Container, open the project directory on VSCode with Dev Containers installed.
143142
**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.
144143

145144
It will run the following command automatically inside the container.
@@ -155,11 +154,9 @@ After finishing the migration, you can proceed.
155154

156155
### Start developing
157156
During development, it is useful to use the
158-
159157
```
160158
pnpm dev
161159
```
162-
163160
command.
164161

165162
- Server-side source files and automatically builds them if they are modified. Automatically start the server process(es).
@@ -232,7 +229,7 @@ niraxは、Misskeyで使用しているオリジナルのフロントエンド
232229
### ルート定義
233230
ルート定義は、以下の形式のオブジェクトの配列です。
234231

235-
``` ts
232+
```ts
236233
{
237234
name?: string;
238235
path: string;
@@ -245,7 +242,7 @@ niraxは、Misskeyで使用しているオリジナルのフロントエンド
245242
}
246243
```
247244

248-
> **Warning**
245+
> [!WARNING]
249246
> 現状、ルートは定義された順に評価されます。
250247
> たとえば、`/foo/:id`ルート定義の次に`/foo/bar`ルート定義がされていた場合、後者がマッチすることはありません。
251248
@@ -307,7 +304,7 @@ export const Default = {
307304
parameters: {
308305
layout: 'centered',
309306
},
310-
} satisfies StoryObj<typeof MkAvatar>;
307+
} satisfies StoryObj<typeof MyComponent>;
311308
```
312309

313310
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.
@@ -418,7 +415,7 @@ describe('test', () => {
418415
})
419416
.useMocker(...
420417
.compile();
421-
418+
422419
fooService = app.get<FooService>(FooService);
423420
barService = app.get<BarService>(BarService) as jest.Mocked<BarService>;
424421

@@ -539,13 +536,13 @@ pnpm dlx typeorm migration:generate -d ormconfig.js -o <migration name>
539536
- 作成されたスクリプトは不必要な変更を含むため除去してください
540537
541538
### JSON SchemaのobjectでanyOfを使うとき
542-
JSON Schemaで、objectに対してanyOfを使う場合、anyOfの中でpropertiesを定義しないこと。
543-
バリデーションが効かないため。(SchemaTypeもそのように作られており、objectのanyOf内のpropertiesは捨てられます)
539+
JSON Schemaで、objectに対してanyOfを使う場合、anyOfの中でpropertiesを定義しないこと。
540+
バリデーションが効かないため。(SchemaTypeもそのように作られており、objectのanyOf内のpropertiesは捨てられます)
544541
https://github.com/misskey-dev/misskey/pull/10082
545542
546543
テキストhogeおよびfugaについて、片方を必須としつつ両方の指定もありうる場合:
547544
548-
```
545+
```ts
549546
export const paramDef = {
550547
type: 'object',
551548
properties: {

0 commit comments

Comments
 (0)