-
Notifications
You must be signed in to change notification settings - Fork 0
Contribution Standards
Thank you for your interest in contributing to the YUI project! Before we get started, please be sure to sign a CLA.
Proposals can be submitted via a pull request or as an idea to the Contributor Mailing List. Submissions that follow our contribution standards and are aligned with the direction of the project will be accepted. Submissions that are not accepted can always be published to YUI Gallery.
Please review YUI’s Contributor Model for more information about how proposals get processed once submitted.
Please review YUI’s Developer Workflow for details on how to set up your Git branches and contribute changes to the YUI project.
The goal of these requirements is to ensure quality, API consistency, code reusability, and maintainability of the contribution. All contributions should satisfy:
- Complete API Docs and inline code comments
- Unit tests with 80% branch coverage
- User Guide (Components only)
- Functional examples, written up in Selleck format and with test automation
- Proper commit logs
The YUI team has created a number of Node.js-based NPM modules to make meeting the above requirements much easier:
- shifter: to build the modules properly and consistently.
- yuidocjs: for live-previewing the API docs.
- selleck: for live-previewing the user guide and functional examples.
- yogi: helper tool wrapping up the functionality from the above tools.
Any submission that uses open source code from another project must be explicitly called out and is subject to review.
Once the contribution has been merged into the repo, if any issues arise in the integration environment or upon subsequent feedback, the contribution may be reverted.