If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don鈥檛 accidentally duplicate your effort.
If somebody claims an issue but doesn鈥檛 follow up for more than two weeks, it鈥檚 fine to take over it but you should still leave a comment.
Prerequisites
- You have Node installed at v8+ and npm installed at v5+
- You understand git and github
After cloning React Habitat, run npm install to install the dependencies. Then the following commands will
become available.
npm run lintchecks code style.npm run testruns the test suite.npm run test:wruns the interactive test suite watcher. Good for development.npm run buildcreates the complete lib and dist folders with packages.npm run build:libcreates just the lib folder with packages.npm run build:umdcreates just the dist folder with the packages.npm run build:umd:mincreates just the dist folder with the minified packages.
To test your work against an existing project. Use npm link
- Run a build (
npm run build). npm linkin React Habitat's root directory.npm link react-habitatin your existing project directory.
Remember to use npm unlink react-habitat to return it to normal.
The core maintainers monitor pull request's whom will perform the reviews.
Before submitting a pull request please ensure the following is done:
- Fork the repository and create your branch from
develop. - If you've fixed a bug or added a feature, add tests.
- Ensure the tests pass (
npm run test). - Make sure your code lints (
npm run lint).