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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Contribution Guide for PR Process and Lint Test in GitHub Actions #615

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ jobs:
- name: Install dependencies
run: pnpm install --frozen-lockfile --strict-peer-dependencies

- name: Run lint
run: pnpm run test:lint

- name: Run test
run: pnpm test

Expand Down
30 changes: 30 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,33 @@ Whenever you make a change to one of the packages, the `pnpm dev` from the proje
Sometimes, this process gets a little out of whack, and if you're not sure what's going on, I usually just quit one or both of the `pnpm dev` commands and restart them.

If you're seeing something unexpected while debugging one of the Next.js demos, try running `rm -rf .next` to refresh the Next.js cache before running `pnpm dev` again.

## Before Pull Request

Before submitting your pull request, please check the following:

1. Run linting:

```bash
pnpm run test:lint
```

If there are any linting errors, please fix them before proceeding with the PR. This helps maintain consistent code quality across the project.

2. Run tests:

```bash
pnpm test
```

Ensure that all the tests pass before submitting your PR. This verifies that your changes don't break existing functionality.

3. Build the project:

```bash
pnpm build
```

Ensure that the project can be built successfully. This confirms that your changes are compatible with the build process.

If all these steps pass, your code is ready for the pull request.