Skip to content

Commit

Permalink
docs: remove the commit example so it sounds less strict
Browse files Browse the repository at this point in the history
  • Loading branch information
BlueCutOfficial committed Nov 28, 2023
1 parent 5c443f8 commit 21d98e4
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,8 @@ git switch --create some-branch-name
### 3. Translate and lint the page

Each PR should have:
- 1 commit
- 2~3 files changed (`[some-page].md`, `.remarkignore`, optionally `.local.dic`)

While you are working, keep your commit stack clean with one commit, for instance: `git commit -m "feat: translate guides/release/index.md`.
- **1 commit** (keep the commit stack clean with one commit, and make the message clear enough to identify the issue number or the file at first glance)
- **2~3 files changed** (`[some-page].md`, `.remarkignore`, optionally `.local.dic`)

Once you have translated the `.md` page of your choice, you need to run the linter to make sure there's no typo:
- Add the path to your page in `.remarkignore` (respect the alphabetical order for readability)
Expand Down

0 comments on commit 21d98e4

Please sign in to comment.