Contributing to Design System
JDRF's Design System is a method of enabling every vendor of JDRF to apply the same level of branding to their sites. We're still working out the kinks to make contributing to this project as easy and transparent as possible, but we're not quite there yet. Hopefully this document makes the process for contributing clear and answers some questions that you may have.
Our Development Process
All of the team will be working directly on GitHub.
npm run test to run the full test suite with PhantomCSS and eventually PhantomJS.
Just make sure to run the whole test suite before submitting a pull request! Any PR without tests will be rejected.
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub
The core team will be monitoring for pull requests.
Before submitting a pull request, please make sure the following is done…
- Fork the repo and create your branch from
- If you've added code that should be tested, add tests!
- Ensure the test suite passes (
npm run test).
- You have not committed compiled files (anything from the dist folder)
Where to Find Known Issues
We will be using GitHub Issues for our public bugs. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn't already exist.
Reporting New Issues
The best way to get your bug fixed is to provide a reduced test case. jsFiddle, jsBin, and other sites provide a way to give live examples. All issues should be reported through Github.
JS Style Guide
If you are unsure about something, looking at Airbnb's Style Guide will guide you in the right direction.
By contributing to JDRF Design System, you agree that your contributions will be licensed under its MIT license.