Skip to content

Commit 1bbf2a9

Browse files
committed
chore: rewording [skip ci]
1 parent 0187f7e commit 1bbf2a9

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

.github/contributing.md

+25-25
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Hi! I'm really excited that you are interested in contributing to Vue Router. Be
1717

1818
## Pull Request Guidelines
1919

20-
- Checkout a topic branch from a base branch, e.g. `main`, and merge back against that branch.
20+
- Check out a topic branch from a base branch, e.g. `main`, and merge back against that branch.
2121

2222
- If adding a new feature:
2323

@@ -26,7 +26,7 @@ Hi! I'm really excited that you are interested in contributing to Vue Router. Be
2626

2727
- If fixing bug:
2828

29-
- If you are resolving a special issue, add `(fix #xxxx[,#xxxx])` (#xxxx is the issue id) in your PR title for a better release log, e.g. `update entities encoding/decoding (fix #3899)`.
29+
- If you are resolving a particular issue, add `(fix #xxxx[,#xxxx])` (#xxxx is the issue id) in your PR title for a better release log, e.g. `update entities encoding/decoding (fix #3899)`.
3030
- Provide a detailed description of the bug in the PR. Live demo preferred.
3131
- Add appropriate test coverage if applicable. You can check the coverage of your code addition by running `pnpm test --coverage`.
3232

@@ -48,7 +48,7 @@ After cloning the repo, run:
4848
pnpm install # install the dependencies of the project
4949
```
5050

51-
A high level overview of tools used:
51+
A high-level overview of tools used:
5252

5353
- [TypeScript](https://www.typescriptlang.org/) as the development language
5454
- [Rollup](https://rollupjs.org) for bundling
@@ -63,7 +63,7 @@ The `build` script builds vue-router
6363

6464
### `pnpm play`
6565

66-
The `play` scripts starts a playground project located at `playground/` that allows you to test things on a browser.
66+
The `play` script starts a playground project located at `playground/`, allowing you to test things on a browser.
6767

6868
```bash
6969
pnpm play
@@ -91,51 +91,51 @@ $ pnpm jest --watch
9191
Vue Router source code can be found in the `src` directory:
9292

9393
- `src/history`: history implementations that are instantiable with `create*History()`. This folder contains code related to using the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API).
94-
- `src/matcher`: RouteMatcher implementation. Contains the code that transforms paths like `/users/:id` into regexps and handle the transformation of locations like `{ name: 'UserDetail', params: { id: '2' } }` to strings. It contains path ranking logic and the part of dynamic routing that concerns matching urls in the right order.
95-
- `src/utils`: contains small utility functions that are used across other sections of the router but are not contained by them.
96-
- `src/router`: contains the router creation, navigation execution, using the matcher, the history implementation. It runs navigation guards.
97-
- `src/location`: helpers related to route location and urls
98-
- `src/encoding`: helpers related to url encoding
94+
- `src/matcher`: RouteMatcher implementation. Contains the code that transforms paths like `/users/:id` into regexps and handles the transformation of locations like `{ name: 'UserDetail', params: { id: '2' } }` to strings. It contains path ranking logic and the part of dynamic routing that concerns matching URLs in the correct order.
95+
- `src/utils`: contains small utility functions used across other router
96+
- `src/router`: contains the router creation, navigation execution, matcher use, and history implementation. It runs navigation guards.
97+
- `src/location`: helpers related to route location and URLs
98+
- `src/encoding`: helpers related to URL encoding
9999
- `src/errors`: different internal and external errors with their messages
100-
- `src/index`: contains all public API as exports.
101-
- `src/types`: contains global types that are used across multiple sections of the router.
100+
- `src/index` contains all public APIs as exports.
101+
- `src/types`: contains global types used across multiple router sections.
102102

103103
## Contributing Tests
104104

105105
Unit tests are located inside `__tests__`. Consult the [Jest docs](https://jestjs.io/docs/en/using-matchers) and existing test cases for how to write new test specs. Here are some additional guidelines:
106106

107107
- Use the minimal API needed for a test case. For example, if a test can be written without involving the reactivity system or a component, it should be written so. This limits the test's exposure to changes in unrelated parts and makes it more stable.
108-
- Use the minimal API needed for a test case. For example, if a test concerns the `router-link` component, don't create a router instance, mock the needed properties instead.
108+
- Use the minimal API needed for a test case. For example, if a test concerns the `router-link` component, don't create a router instance, mock the required properties instead.
109109
- Write a unit test whenever possible
110-
- If a test is specific to a browser, create an e2e (end to end) test and make sure to indicate it on the test
110+
- If a test is specific to a browser, create an e2e (end-to-end) test and make sure to indicate it on the test
111111

112112
## Contributing Docs
113113

114-
Currently, all the docs can be found in `packages/docs`. It contains the English markdown files while translation(s) are stored in their corresponding `<lang>` sub-folder(s):
114+
All the documentation files can be found in `packages/docs`. It contains the English markdown files while translation(s) are stored in their corresponding `<lang>` sub-folder(s):
115115

116116
- [`zh`](https://github.com/vuejs/router/tree/main/packages/docs/zh): Chinese translation.
117117

118-
Besides that, the `.vitepress` sub-folder is used to put the config and theme, including the i18n information.
118+
Besides that, the `.vitepress` sub-folder contains the config and theme, including the i18n information.
119119

120-
Contributing to the English docs is the same as contributing to the source code. You can simply create a pull request to our GitHub repo. However, if you would like to contribute to the translations, there are 2 options and some extra steps to follow:
120+
Contributing to the English docs is the same as contributing to the source code. You can create a pull request to our GitHub repo. However, if you would like to contribute to the translations, there are two options and some extra steps to follow:
121121

122122
### Translate in a `<lang>` sub-folder and host it on our official repo
123123

124124
If you want to start translating the docs in a _new_ language:
125125

126126
1. Create the corresponding `<lang>` sub-folder for your translation.
127-
2. Modify the i18n config in `.vitepress` sub-folder.
127+
2. Modify the i18n configuration in the `.vitepress` sub-folder.
128128
3. Translate the docs and run the doc site to self-test locally.
129-
4. Create a checkpoint for your language by running `pnpm run docs:translation-status <lang> [<commit>]`. A checkpoint is the hash and date of the latest commit when you do the translation. The checkpoint information would be stored in the status file `packages/docs/.vitepress/translation-status.json`. _It's important for the long-term maintenance since all the further translation sync-ups would be based on their previous checkpoints._ Usually you can skip the commit argument because the default value is `main`.
129+
4. Create a checkpoint for your language by running `pnpm run docs:translation-status <lang> [<commit>]`. A checkpoint is the hash and date of the latest commit when you do the translation. The checkpoint information is stored in the status file `packages/docs/.vitepress/translation-status.json`. _It's crucial for long-term maintenance since all the further translation sync-ups are based on their previous checkpoints._ Usually, you can skip the commit argument because the default value is `main`.
130130
5. Commit all the changes and create a pull request to our GitHub repo.
131131

132-
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.
132+
We will have a paragraph at the top of each translation page that shows the translation status. That way, users can quickly determine if the translation is up-to-date or lags behind the English version.
133133

134134
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:
135135

136-
1. See what translation you need to sync up with the original docs. There are 2 popular ways:
137-
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
138-
2. Via a local command: `pnpm run docs:compare-to-translate <lang> [<commit>]`.
136+
1. See what translation you need to sync up with the original docs. There are two popular ways:
137+
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`. 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
138+
2. Via a local command: `pnpm run docs:compare-to-translate <lang> [<commit>]`.
139139
2. Create your own branch and start the translation update, following the previous comparison.
140140
3. Create a checkpoint for your language by running `pnpm run docs:translation-status <lang> [<commit>]`.
141141
4. Commit all the changes and create a pull request to our GitHub repo.
@@ -144,12 +144,12 @@ Speaking of the up-to-date translation, we also need good long-term maintenance
144144

145145
### Self-host the translation
146146

147-
You can also host the translation on your own. To create one, just simply fork our GitHub repo and change the content and site config in `packages/docs`. To long-term maintain it, we _highly recommend_ a similar way that we do above for our officially hosted translations:
147+
You can also host the translation on your own. To create one, fork our GitHub repo and change the content and site config in `packages/docs`. To long-term maintain it, we _highly recommend_ a similar way that we do above for our officially hosted translations:
148148

149-
- Ensure you maintain the _checkpoint_ properly. And also ensure the _translation status_ is well-displayed on the top of each translation page.
149+
- Ensure you maintain the _checkpoint_ properly. Also, ensure the _translation status_ is well-displayed on the top of each translation page.
150150
- Utilize the diff result between the latest official repository and your own checkpoint to guide your translation.
151151

152-
Tip: you can add the official repo as a remote to your forked repo, this way you can still run `pnpm run docs:translation-status <lang> [<commit>]` and `npm run docs:compare-to-translate <lang> [<commit>]` to get the checkpoint and diff result:
152+
Tip: you can add the official repo as a remote to your forked repo. This way, you can still run `pnpm run docs:translation-status <lang> [<commit>]` and `npm run docs:compare-to-translate <lang> [<commit>]` to get the checkpoint and diff result:
153153

154154
```bash
155155
# prepare the upstream remote

0 commit comments

Comments
 (0)