The Arwes project would love to welcome your contributions! There are many ways to help out:
- Create an issue on GitHub, if you have found a bug
- Write test cases for open bug issues
- Write patches for open bug/feature issues, preferably with test cases included
- Contribute to the documentation
- Blog about how to use the package and its tools or brag about how it works for you
When contributing to this repository, please first discuss the change you wish to make via issue with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
This package uses React v16. To install repository dependencies:
$ npm installreact-live is used to play with the components. To start the playground to experiment with them:
$ npm run playIt will start a server at http://127.0.0.1:7100
to list all components to play with.
The playground application is run with the app in /play. Each component
sandbox is defined in each component folder with the file Play.md where the
code snippet will be passed to react-live to execute it. The assets in the
/static folder are used.
To test the components and modules karma, chai, sinon and enzyme are used. Run them using:
# run linter and tests once
$ npm run test
# or with watcher
$ npm run test-devnext.js is used with support to read Markdown
files as text/plain. The pages are in /pages, the components and utilities
for the website are in /site and static files are served from /static.
The script /script/api.js (run with $ npm run script-api) creates the
documentation definitions for the components to be used in the site.
Run the website with:
$ npm run site-devIt will open a server at http://127.0.0.1:7000.
The Airbnb JavaScript Style Guide is used.
Install editorconfig and eslint in your editor/IDE and follow the conventions established by them.