sugar/nixcn-web
1
0
Fork 0
Code Activity

Modify README rules and format

Browse Source 
- Lint README format
- Add one rule in Contribution section

Signed-off-by: Asai Neko <sugar@sne.moe>
This commit is contained in:
Asai Neko
2025-12-07 21:34:58 +08:00
parent 05f0552f42
commit 3e06961805
1 changed files with 13 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -2,15 +2,16 @@
## Contribution ## Contribution
1. **Root docs serve the zh-CN version** *[MUST]* 1. **Root docs serve the zh-CN version** _[MUST]_
2. **Use sign-off via `git commit -s`** *[MUST]* 2. **Use sign-off via `git commit -s`** _[MUST]_
3. **Do not modify the `main` branch for any reason** *[MUST]* 3. **Do not modify the `main` branch for any reason** _[MUST]_
4. **Do not omit the commit subject for any reason** *[MUST]* 4. **Do not omit the commit subject for any reason** _[MUST]_
5. **Describe all changes in the commit message** *[MUST]* 5. **Describe all changes in the commit message** _[MUST]_
6. **Rebase before submitting patches** *[MUST]* 6. **Rebase before submitting patches** _[MUST]_
7. **Split commits for large or multi-part changes** *[OPTION]* 7. **Commit message written in english** _[MUST]_
8. **Use OpenPGP/SSH for commit signing** *[OPTION]* 8. **Split commits for large or multi-part changes** _[OPTION]_
9. **Have fun contributing :)** *[VERY NECESSARY]* 9. **Use OpenPGP/SSH for commit signing** _[OPTION]_
0. **Have fun contributing :)** _[VERY NECESSARY]_
## Toolchain ## Toolchain
@@ -23,9 +24,9 @@
All commands are run from the root of the project, from a terminal: All commands are run from the root of the project, from a terminal:
| Command | Action | | Command | Action |
| :------------------------ | :----------------------------------------------- | | :--------------------- | :----------------------------------------------- |
| `yarn install` | Installs dependencies | | `yarn install` | Installs dependencies |
| `yarn dev` | Starts local dev server at `localhost:4321` | | `yarn dev` | Starts local dev server at `localhost:4321` |
| `yarn build` | Build your production site to `./dist/` | | `yarn build` | Build your production site to `./dist/` |
| `yarn preview` | Preview your build locally, before deploying | | `yarn preview` | Preview your build locally, before deploying |