You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21-24
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# Contribution guide
2
2
We're glad you're interested in contributing Misskey! In this document you will find the information you need to contribute to the project.
3
3
4
-
> **Note**
4
+
> [!NOTE]
5
5
> This project uses Japanese as its major language, **but you do not need to translate and write the Issues/PRs in Japanese.**
6
6
> Also, you might receive comments on your Issue/PR in Japanese, but you do not need to reply to them in Japanese as well.\
7
7
> 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:
17
17
- Issues should only be used to feature requests, suggestions, and bug tracking.
18
18
- Please ask questions or troubleshooting in [GitHub Discussions](https://github.com/misskey-dev/misskey/discussions) or [Discord](https://discord.gg/Wp8gVStHW3).
19
19
20
-
> **Warning**
20
+
> [!WARNING]
21
21
> Do not close issues that are about to be resolved. It should remain open until a commit that actually resolves it is merged.
22
22
23
-
24
23
### Recommended discussing before implementation
25
-
We welcome your purposal.
24
+
We welcome your proposal.
26
25
27
26
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.
28
27
29
28
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.
30
29
PRs that do not have a clear set of do's and don'ts tend to be bloated and difficult to review.
31
30
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).
33
32
By expressing your intention to work on the Issue, you can prevent conflicts in the work.
34
33
35
34
To the Committers: you should not assign someone on it before the Final Decision.
36
35
37
36
### How issues are triaged
38
37
39
-
The Commiters may:
38
+
The Committers may:
40
39
* close an issue that is not reproducible on latest stable release,
41
40
* merge an issue into another issue,
42
41
* split an issue into multiple issues,
43
42
* or re-open that has been closed for some reason which is not applicable anymore.
44
43
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.
46
45
47
46
## Well-known branches
48
47
-**`master`** branch is tracking the latest release and used for production purposes.
@@ -53,14 +52,14 @@ The Commiters may:
53
52
## Creating a PR
54
53
Thank you for your PR! Before creating a PR, please check the following:
55
54
- If possible, prefix the title with a keyword that identifies the type of this PR, as shown below.
- 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.
58
57
- If there is an Issue which will be resolved by this PR, please include a reference to the Issue in the text.
59
58
- 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.
60
59
- Check if there are any documents that need to be created or updated due to this change.
61
60
- If you have added a feature or fixed a bug, please add a test case if possible.
62
61
- 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)
64
63
- If this PR includes UI changes, please attach a screenshot in the text.
65
64
66
65
Thanks for your cooperation 🤗
@@ -70,8 +69,8 @@ Be willing to comment on the good points and not just the things you want fixed
70
69
71
70
### Review perspective
72
71
- 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?
75
74
- Security
76
75
- Does merging this PR create a vulnerability?
77
76
- Performance
@@ -93,7 +92,7 @@ An actual domain will be assigned so you can test the federation.
93
92
94
93
## Release
95
94
### 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))
97
96
2. Create a release PR.
98
97
- Into `master` from `develop` branch.
99
98
- 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.
104
103
- The target branch must be `master`
105
104
- The tag name must be the version
106
105
107
-
> **Note**
106
+
> [!NOTE]
108
107
> Why this instruction is necessary:
109
108
> - To perform final QA checks
110
109
> - To distribute responsibility
@@ -139,7 +138,7 @@ You could obtain middleware container by typing `docker compose -f $PROJECT_ROOT
139
138
Devcontainer also has necessary setting. This method can be done by connecting from VSCode.
140
139
141
140
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.
143
142
**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.
144
143
145
144
It will run the following command automatically inside the container.
@@ -155,11 +154,9 @@ After finishing the migration, you can proceed.
155
154
156
155
### Start developing
157
156
During development, it is useful to use the
158
-
159
157
```
160
158
pnpm dev
161
159
```
162
-
163
160
command.
164
161
165
162
- Server-side source files and automatically builds them if they are modified. Automatically start the server process(es).
0 commit comments