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