Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (27 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.22 KB

Contributing to react-day-picker

⚠️ The master branch is for the upcoming v8 release. Switch to the v7 branch to send updates for the v7 version.

You are welcome to join the other contributors and help improving react-day-picker!

Contributing to v8

The upcoming majore release is a Typescript rewrite. Checkout the v8 project to see what's left to do.

Developing environment

  • The repository is using workspaces with yarn v2
    • There are two workspaces, one for the website and one for the package
  • Website is built with docusaurus
  • The Node.js version we use is ^12.0

Start contributing now

1. Fork the repo on your local machine

git clone https://github.com/gpbl/react-day-picker.git
cd react-day-picker
yarn install

2. Start the development environment

Build the package and website in watch mode:

yarn develop

3. Apply changes and open a PR :)

  • add tests and make sure they pass: yarn test
  • make sure your files are linted: yarn lint