Skip to content

Commit 3125a0c

Browse files
committed
doc: Update contribution guidelines (PR checklist)
1 parent 03cc741 commit 3125a0c

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

CONTRIBUTING.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contribution Guidelines
22

3-
First off, thanks for your help!
3+
First off, thanks for your help! 🙏
44

55
## Getting started
66

@@ -47,7 +47,18 @@ inspect it locally.
4747

4848
## Proposing changes
4949

50+
Make sure your changes:
51+
52+
1. Pass the tests: `pnpm test`
53+
2. Pass linting checks: `pnpm lint`
54+
3. Have relevant documentation additions / updates (in the `packages/docs/content` and the README.md file).
55+
5056
This repository uses [`semantic-release`](https://semantic-release.gitbook.io/semantic-release/)
5157
to automatically publish new versions of the package to NPM.
5258
To do this, the Git history follows the
5359
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format.
60+
61+
Pull requests should target the `next` branch.
62+
63+
If your changes impact the `nuqs` package, you'll get a comment from [pkg.pr.new](https://pkg.pr.new)
64+
with a preview deployment of the package you can install in your application.

0 commit comments

Comments
 (0)