Skip to content

There can be more than Notion and Miro. AFFiNE(pronounced [ə‘fain]) is a next-gen knowledge base that brings planning, sorting and creating all together. Privacy first, open-source, customizable and ready to use.

docs: improve grammar of contributing `releases.md` (#10032)

glitched-w0rld2b9ccf8fcf6e
diff --git a/docs/contributing/releases.md b/docs/contributing/releases.md
index 1e2b5ee2fc..3dca73c5e0 100644
--- a/docs/contributing/releases.md
+++ b/docs/contributing/releases.md
@@ -1,49 +1,47 @@
-## AFFiNE Release Process
+## AFFiNE Release Process
> In order to make a stable/beta release, you need to get authorization from the AFFiNE test team.
-## Who can make a release?
+## Who Can Make a Release?
-The AFFiNE core team gives release authorization. And also have the following requirements.
+The AFFiNE core team grants release authorization and enforces the following requirements:
-- Have commit access to the AFFiNE repository.
-- Have access to GitHub Actions.
+- Commit access to the AFFiNE repository.
+- Access to GitHub Actions.
-## How to make a release?
+## How to Make a Release
-Before releasing, ensure you have the latest version of the `canary` branch.
+Before releasing, ensure you have the latest version of the `canary` branch and review the [SemVer](https://semver.org) specification to understand versioning.
-And Read the semver specification to understand how to version your release. https://semver.org
-
-### 1. Update the version in `package.json`
+### 1. Update the Version in `package.json`
```shell
./scripts/set-version.sh 0.5.4-canary.5
```
-### 2. Commit changes and push to `canary`
+### 2. Commit Changes and Push to `canary`
```shell
git add .
-# vx.y.z-canary.n
+# vX.Y.Z-canary.N
git commit -m "v0.5.4-canary.5"
git push origin canary
```
-### 3. Create a release action
-
-Create a release action in the [Release Desktop App](https://github.com/toeverything/AFFiNE/actions/workflows/release-desktop-app.yml).
+### 3. Create a Release Action
-![img.png](assets/release-action.png)
+Trigger a release action in the [Release Desktop App](https://github.com/toeverything/AFFiNE/actions/workflows/release-desktop-app.yml).
-Select the correct branch and fill out the form, then click `Run workflow`.
+![img.png](assets/release-action.png)
-### 4. Publish the release
+Select the appropriate branch, complete the form, and click `Run workflow`.
-After the release action is completed, you can see the draft release on the [release page](https://github.com/toeverything/AFFiNE/releases).
+### 4. Publish the Release
-You can edit the release note and publish it.
+Once the release action is complete, a draft release will appear on the [Releases page](https://github.com/toeverything/AFFiNE/releases).
-Remember that the release tag and title should be the same as the version in `package.json`.
+Edit the release notes if necessary, then publish the release.
-And target the release to that commit you just pushed.
+Ensure that:
+- The release tag and title match the version in `package.json`.
+- The release targets the commit you just pushed.