Skip to content

Commit a2e2b3d

Browse files
committed
chore(guide): add Before Pull Request Guide
1 parent 9f57894 commit a2e2b3d

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

contributing.md

+30
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,33 @@ Whenever you make a change to one of the packages, the `pnpm dev` from the proje
4040
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.
4141

4242
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.
43+
44+
## Before Pull Request
45+
46+
Before submitting your pull request, please check the following:
47+
48+
1. Run linting:
49+
50+
```bash
51+
pnpm run test:lint
52+
```
53+
54+
If there are any linting errors, please fix them before proceeding with the PR. This helps maintain consistent code quality across the project.
55+
56+
2. Run tests:
57+
58+
```bash
59+
pnpm test
60+
```
61+
62+
Ensure that all the tests pass before submitting your PR. This verifies that your changes don't break existing functionality.
63+
64+
3. Build the project:
65+
66+
```bash
67+
pnpm build
68+
```
69+
70+
Ensure that the project can be built successfully. This confirms that your changes are compatible with the build process.
71+
72+
If all these steps pass, your code is ready for the pull request.

0 commit comments

Comments
 (0)