Skip to content

CONTRIBUTORS.md

Latest commit

 

History

History
45 lines (28 loc) · 1.28 KB

CONTRIBUTORS.md

File metadata and controls

45 lines (28 loc) · 1.28 KB
Raw

FullCalendar React Component Contributor Guide

Information for people wanting to contribute code to this project.

Build Commands

Look in package.json to see all available build scripts, the most important being:

npm run build
npm run watch # continusouly build
npm run test # continuously test
npm run dist # build everything necessary for the NPM package

Before Submitting

Before submitting a PR, make sure testing and linting pass:

npm run test-single
npm run lint

Also, make sure the js example project and typescript example project both build correctly with the new code. To test, use npm link to trick them into using your not-yet-published dist files.

Publishing

For publishing to NPM/Github, run something like this:

./scripts/version 9.9.9 # build and stage the release
./scripts/publish 9.9.9 # publish to verdaccio (local npm server)
./scripts/publish 9.9.9 --production # publish to npm, push to github

This will create a detached+tagged release commit.