The Rice Project strives for a simple and quick contribution process. However, there are some specific requirements we need to enforce.
Contributor License Agreement
Every contributor must have a Contributor License Agreement (CLA) on file with Kuali.
Steps for submitting the CLA:
- Create an account at http://kis.kuali.org/ (details: Create a KIS account)
- Sign the Contributor License Agreement, scan and send it to email@example.com (Details: License Agreement Process (CLA / CCLA))
Fork - Code - Pull Request
These steps are done by you:
- Fork the Kuali Rice repository at Github https://github.com/kuali/rice
- Create a pull request with the changes to be contributed.
- Create a separate pull request for each feature.
- Squash pull request into one commit.
- Monitor the comments of the pull request. Discuss, fix, and update pull request as needed.
Pull Request Review
These steps are done by the Kuali Rice developer team:
- Check if CLA is on file. Without this the contribution cannot be considered to any extend.
- Creation of a KULRICE ticket to track the contribution.
- The contribution is reviewed by the developers for:
- code style and formatting
- code correctness
- applicability of the contribution
- An automated build will be run against the pull request to verify that the project builds and all unit test passes.
- Integration and functional test will be run and must pass. It is up to the discretion of the Kuali Rice developer team whether these tests are run before or after the pull request is merged.
You are encouraged to contact the Kuali Rice development team at any time via the collaboration mailing list (firstname.lastname@example.org) for questions including if the Kuali Rice project is interested in the contribution. It is actually preferred that an initial contact has been made and a KULRICE ticket is issued and included in the commit description and pull request.
- Git/GitHub Workflow, Policies and Usage
- Database Change and Migration Policy
- Unit Testing and Build PolicyDocumentation Policy.