Skip to content

Commit 41dab1f

Browse files
authored
add tldr to contributing (#10417)
1 parent 3657383 commit 41dab1f

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,20 @@ Wrangler is an open-source project and we welcome contributions from you. Thank
44

55
Below you can find some guidance on how to be most effective when contributing to the project.
66

7+
## tl;dr for contributing to Wrangler
8+
9+
Useful commands for developing Wrangler (all commands below should be run in the project root):
10+
11+
- `pnpm i; pnpm build` will build everything in workers-sdk.
12+
- `pnpm dev -F wrangler` will watch and build changes while you develop. Fixtures use the build output from this, and are useful for messing around during dev (`fixtures/worker-ts` is a useful blank slate).
13+
14+
Before committing/submitting a PR:
15+
16+
- Add [tests](#pr-tests). `pnpm test -F wrangler` will run Wrangler's unit tests. You can filter tests: e.g. `pnpm test -F wrangler "containers"`.
17+
- Run `pnpm check` for typechecking and linting.
18+
- Add a [changeset](#changesets) with `pnpm changeset`.
19+
- Don’t squash your commits after a review.
20+
721
## Before getting started
822

923
We really appreciate your interest in making a contribution, and we want to make sure that the process is as smooth and transparent as possible! To this end, we note that the Workers team is actively doing development in this repository, and while we consistently strive to communicate status and current thinking around all open issues, there may be times when context surrounding certain items is not up to date. Therefore, **for non-trivial changes, please always engage on the issue or create a discussion or feature request issue first before writing your code.** This will give us opportunity to flag any considerations you should be aware of before you spend time developing. Of course, for trivial changes, please feel free to go directly to filing a PR, with the understanding that the PR itself will serve as the place to discuss details of the change.

0 commit comments

Comments
 (0)