From a33d15f97962f50bf0ef30676fb51f8973d3c47c Mon Sep 17 00:00:00 2001 From: Jinjiang Date: Mon, 18 Sep 2023 16:17:29 +0000 Subject: [PATCH] Update contributing.md --- .github/contributing.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/contributing.md b/.github/contributing.md index ecdc4eefe..0f488556a 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -131,13 +131,14 @@ If you want to start translating the docs in a _new_ language: We will have a paragraph right at the top of each translation page that shows the status of the translation. That way, users can easily figure out if the translation is up-to-date or lags behind the English version. -If you want to maintain an existing translation: +Speaking of the up-to-date translation, we also need good long-term maintenance for every language. If you want to _update_ an existing translation: -1. See what translation you need to do to sync up with the original docs. There are 2 popular ways: - 1. Via the GitHub Compare page: https://github.com/vuejs/router/compare/ (only see the changes in `packages/docs/*`) from the checkpoint hash to `main` branch. You can find the checkpoint hash for your language via the translation status file `packages/docs/.vitepress/translation-status.json`. - 2. Via a local command: `pnpm run docs:compare-to-translate []`. +1. See what translation you need to sync up with the original docs. There are 2 popular ways: + 1. Via the [GitHub Compare](https://github.com/vuejs/router/compare/) page: only see the changes in `packages/docs/*` from the checkpoint hash to `main` branch. You can find the checkpoint hash for your language via the translation status file `packages/docs/.vitepress/translation-status.json`. And the compare page can be directly opened with the hash as part of the URL e.g. https://github.com/vuejs/router/compare/e008551...main + 2. Via a local command: `pnpm run docs:compare-to-translate []`. 2. Create your own branch and start the translation update, following the previous comparison. -3. Same to step 4 and step 5 in the “starting a new language” workflow. Once you have done all above, create a pull request and then wait for the maintainers to approve and merge it. +3. Create a checkpoint for your language by running `pnpm run docs:translation-status []`. +4. Commit all the changes and create a pull request to our GitHub repo.