You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/contributing.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,9 +34,9 @@ Hi! I'm really excited that you are interested in contributing to Vue Router. Be
34
34
35
35
- Make sure tests pass!
36
36
37
-
- Commit messages must follow the [commit message convention](./commit-convention.md) so that the changelog can be automatically generated. Commit messages are automatically validated before commit (by invoking [Git Hooks](https://git-scm.com/docs/githooks) via [yorkie](https://github.com/yyx990803/yorkie)).
37
+
- Commit messages must follow the [commit message convention](./commit-convention.md) so that the changelog can be automatically generated. Commit messages are automatically validated before commit (by invoking [Git Hooks](https://git-scm.com/docs/githooks) via [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks)).
38
38
39
-
- No need to worry about code style as long as you have installed the dev dependencies - modified files are automatically formatted with Prettier on commit (by invoking [Git Hooks](https://git-scm.com/docs/githooks) via [yorkie](https://github.com/yyx990803/yorkie)).
39
+
- No need to worry about code style as long as you have installed the dev dependencies - modified files are automatically formatted with Prettier on commit (by invoking [Git Hooks](https://git-scm.com/docs/githooks) via [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks)).
40
40
41
41
## Development Setup
42
42
@@ -52,7 +52,7 @@ A high-level overview of tools used:
52
52
53
53
-[TypeScript](https://www.typescriptlang.org/) as the development language
54
54
-[Rollup](https://rollupjs.org) for bundling
55
-
-[Jest](https://jestjs.io/) for unit testing
55
+
-[Vitest](https://vitest.dev/) for unit testing
56
56
-[Prettier](https://prettier.io/) for code formatting
57
57
58
58
## Scripts
@@ -83,7 +83,7 @@ The `pnpm test` script runs all checks:
83
83
$ pnpm test
84
84
85
85
# run unit tests in watch mode
86
-
$ pnpm jest --watch
86
+
$ pnpm test:unit --watch
87
87
```
88
88
89
89
## Project Structure
@@ -102,7 +102,7 @@ Vue Router source code can be found in the `src` directory:
102
102
103
103
## Contributing Tests
104
104
105
-
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:
105
+
Unit tests are located inside `__tests__`. Consult the [Vitest docs](https://vitest.dev/guide/) and existing test cases for how to write new test specs. Here are some additional guidelines:
106
106
107
107
- 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
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.
0 commit comments