This page contains guidelines for contributing to the Rimmu Open E-learning Project. Please review these guidelines before submitting any pull requests to the framework.
The pull request process differs for new features and bugs. Before sending a pull request for a new feature, you should first create an issue with [Proposal] in the title. The proposal should describe the new feature, as well as implementation ideas. The proposal will then be reviewed and either approved or denied. Once a proposal is approved, a pull request may be created implementing the new feature. Pull requests which do not follow this guideline will be closed immediately.
Pull requests for bugs may be sent without creating any proposal issue. If you believe that you know of a solution for a bug that has been filed on Github, please leave a comment detailing your proposed fix.
If you have an idea for a new feature you would like to see added to Rimmu, you may create an issue on Github with [Request] in the title. The feature request will then be reviewed by a core contributor.
Rimmu follows the PSR-0 and PSR-1 coding standards. In addition to these standards, below is a list of other coding standards that should be followed:
- Namespace declarations should be on the same line as
<?php. - Class opening
{should be on the same line as the class name. - Function and control structure opening
{should be on a separate line.