Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

adjust contributing document #9641

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 26 additions & 9 deletions CONTRIBUTING.md
Expand Up @@ -12,30 +12,43 @@ Here is a quick guide to doing code contributions to the library.

3. Install packages by running:

> pnpm install
```shellscript
pnpm install
```

4. If you've added a code that should be tested, ensure the test suite still passes.

> pnpm test && pnpm tsd
```shellscript
pnpm test && pnpm tsd
```

5. Try to write some unit tests to cover as much of your code as possible.

6. Ensure your code lints without errors.

> pnpm lint
```shellscript
pnpm lint
```

7. Ensure the automation suite passes by running two following commands in parallel:

> pnpm start
> pnpm cypress
```shellscript
pnpm start
# In another terminal, while 'start' runs:
pnpm e2e
```

8. Ensure build passes.

> pnpm build
```shellscript
pnpm build
```

9. Ensure exports are documented. (requires build)

> pnpm api-extractor
```shellscript
pnpm api-extractor
```

10. Push your branch: `git push -u origin your-meaningful-branch-name`

Expand Down Expand Up @@ -68,11 +81,15 @@ it('should render correctly', () => {

2. Open Jest Preview Dashboard

> pnpm jest-preview
```shellscript
pnpm jest-preview
```

3. Run the tests

> pnpm test:watch
```shellscript
pnpm test:watch
```

The browser will reloads automatically when `debug()` is executed.

Expand Down