-
Notifications
You must be signed in to change notification settings - Fork 1
Home
Here you will find the developer documentation: Kolibre client developer documentation
A patch also focuses on fixing/improving one thing, and one thing only. Don't submit several bug fixes in one patch. Split them into several smaller patches instead.
Before you submit you patch, please make sure that you are using the same coding convention as we do. If the patch is messy and violates our convention we reject your patch and kindly ask you to redo it.
Our conventions are:
- variables and functions names shall be self explanatory
- use four spaces for tabs
- insert comments when you feel they are necessary
- write short and clear commit messages
- use decent user name and email address
When you have committed your changes to your own origin/master branch, make a pull request. Via the github web interface, push the "Pull request" button and fill the form fields with information that describes the intention of the patch.
If your patch is accepted it will be merged into our master branch and you can later pull our changes to your fork and start working on another patch. No need to re-fork the project when you have done it once already.
Feature requests for the Kolibre project are warmly welcome and we are glad to review any ideas that you have. To suggest a feature, all you have to do is present your idea in an email to [email protected] (Kolibre development mailing list).
When you suggest a feature, try to consider the following questions:
- What kinds of users need this feature?
- How does it work and how can users access it? Describe the work flow.
- Are resources (employed developers) from the Kolibre Foundation needed in order to implement it? That is, is this a suggestion for the official roadmap or for the community wishlist?
- Other motivations why it is needed?
Whether it ends up on the roadmap or wishlist depends on resources available and requirements defined by the suggester.
If you have any questions, contact us at [email protected]