Skip to content

Latest commit

 

History

History
49 lines (37 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

49 lines (37 loc) · 1.93 KB

Contributing to DayPicker

You are welcome to join the DayPicker contributors, help us building the best date picker for React.

There are many ways to help the development of DayPicker:

  • Improve our build tools and Github actions
  • Opening PRs with new features, bug fixes and improved rendering performance
  • Align the source code to the latest Typescript / React practices
  • Helping with unit and integration tests
  • Proofreading our website and the code documentation in the source files
  • Making the website more stylish
  • Help maintaining the repository on Github and triaging issues and PRs
  • Answering our support questions
  • Sponsoring the project

Send a message in our discussions page to present yourself, or write the maintainer directly at io@gpbl.dev.

Working with the source code

This repository works with Yarn 2 workspaces to enable hot module reloading during development.

  • ./package/react-day-picker: this workspace contains the DayPicker source code and the development tools
  • ./playground: a React app useful to live testing. In the future should contains enough use cases for running integration tests.
  • ./website: the Docusaurus app for the documentation website
$ git clone git@github.com:gpbl/react-day-picker.git
$ cd react-day-picker
$ yarn install

To build and start watching the source run the develop script:

$ yarn workspace react-day-picker develop

To run the unit tests in watch mode:

$ yarn workspace react-day-picker test --watch