Looking to contribute to Gibbon? Awesome, you’re in the right place. Gibbon is a work of volunteer labour, built with love and passion by people just like you.
You can contribute your time and expertise many ways. For example, you might:
- Write tutorials and “how-to” articles for the Gibbon documentation.
- Help people with the questions they ask on the Support forum.
- Create a module that provides additional functionality above and beyond the core.
- Expand our internationalization and help translate Gibbon in your language.
- Improve the existing guides and documentation of features in Gibbon.
- Submit bug reports or hack on Gibbon itself by fixing bugs you’ve found in the GitHub Issue tracker.
A huge thank you 💜 to our growing team of volunteer developers and translators for their ongoing work to make Gibbon better for all of us.
How to report a bug
Before submitting a bug, please do the following:
- Make sure you’re on the latest version, your problem may have been solved already!
- Perform basic troubleshooting steps and note the steps required to reproduce the bug.
- Check the bug/issue tracker and planning board to make sure it’s not a known issue.
- Submit the bug by creating an issue and follow the template provided for what to put in your bug report.
:exclamation: If you find a security vulnerability, do NOT open an issue. Please email email@example.com instead.
How to suggest a feature
To request new features, please use the Feature Requests category in our support forums. You can find more info about planned features and upcoming releases on the Gibbon Development Road Map.
How to help translate
Thanks to some amazing volunteers, Gibbon is available in several different languages. If you would like to help translate Gibbon, please email firstname.lastname@example.org. Your help would be most appreciated!
How to submit a pull request
The Gibbon philosophy is to perform small, easily tested changes to an ongoing development branch. An ideal pull request adds one feature or fixes one bug at a time. If you’re unsure where to begin with GitHub feel free to reach out on the Support forum or check out these great guides: makeapullrequest.com and opensource.guide
- Fork the GibbonEdu/core repository on GitHub and clone a copy on your local machine.
- Write some code and push your changes to your repo using the command line or your favourite Git GUI.
- Create a new pull request and fill in the template provided to tell us about your change.
- Be sure you’re submitting your pull request to the development branch (and not master).
- Submissions should have a changelog entry noting what was added, changed or fixed.
Thanks for reading!
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they’ll reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.