Skip to content

Commit

Permalink
chore: add short contributor guide
Browse files Browse the repository at this point in the history
  • Loading branch information
quantizor committed May 31, 2023
1 parent 4fcf01c commit 6571ee4
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions packages/formik/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,16 @@
- Jared Palmer [@jaredpalmer](https://twitter.com/jaredpalmer)
- Ian White [@eonwhite](https://twitter.com/eonwhite)

## Contributing

This monorepo uses `yarn`, so to start you'll need the package manager installed.

To run E2E tests you'll also need Playwright set up, which can be done locally via `npx playwright install`. Afterward, run `yarn start:app` and in a separate tab run `yarn e2e:ui` to boot up the test runner.

When you're done with your changes, we use [changesets](https://github.com/changesets/changesets) to manage release notes. Run `yarn changeset` to autogenerate notes to be appended to your pull request.

Thank you!

## Contributors

Formik is made with <3 thanks to these wonderful people
Expand Down

0 comments on commit 6571ee4

Please sign in to comment.