Skip to Main Content

.

.

.

Contributing process | General guidelines | Using generative AI | Note on Windows | Repositories overview | Asking questions | Connecting with us | Kolibri Contributors

Learning Equality was founded by a group of volunteer students committed to making quality education a reality for underserved learners and educators everywhere.

In order to effectively cater to different learning environments and needs, we build open-source tools that are free to use and easily adaptable. And we do it while building community, with the help of volunteer developers from around the globe.  

If you are a developer looking to join our community, you’re in the right place. Welcome!

Contributing process

  1. Review “General guidelines” and “Using generative AI”.
  2. Find an unassigned ‘help wanted’ issue and request assignment in issue comments.
  3. Familiarize yourself with the relevant repository. Find the most common ones in the “Repositories Overview”.
  4. Briefly skim through developer documentation for future reference.

  5. Follow the development server setup instructions. Refer to “Asking questions” if problems arise.

  6. Use issue comments to discuss questions specific to the issue.

.

General guidelines

  • Be a courteous and respectful community member. Support fellow contributors. Avoid competing for issue assignments.
  • If you were invited to our Slack channel, post only in #dev-community. Avoid direct messages to the team.
  • Focus solely on unassigned 'help wanted' issues. Request up to two issue assignments at a time. Do not open a pull request without being assigned the relevant issue. We won’t assign any other issues. If there are none free, wait until new ones are added. Once you complete a task, feel free to request more. If you can’t complete an issue, no problem—just let us know.
  • We're happy to clarify and communicate, but we cannot guide contributors step by step. If it's hard to make progress, feel free to request to be unassigned and pick a more suitable issue instead.
  • Open a pull request only if you’re willing to address feedback during the review. Dedicate time to filling out the pull request template and describing the changes clearly.

.

Using generative AI

You're welcome to use generative AI to brainstorm solutions or generate code. but we ask that you do so wisely and in a way that fosters collaboration. Pull requests and comments that appear to be written by AI, giving off the impression that they have not been thoroughly understood, adjusted, and tested by the author won’t be answered. Here are few guidelines for how to best use AI:

Code generation

Feel free to brainstorm or generate code with AI. However we expect that you:

  • Understand the task and solution thoroughly
  • Evaluate and refine every line of the generated output
  • Follow codebase conventions
  • Clean up duplicates, comments, and irrelevant code
  • Manually test functionality
  • Ensure pull request descriptions are accurate and concise

Communication

Feel free to use AI to correct your spelling or better phrase your ideas. However make sure to:

  • Avoid copy-pasting long and generic texts
  • Share only relevant and actionable information that you verified—no hypothetical debugging steps, suggestions, or solutions.

.

Note on Windows

Using Windows for development is not recommended and we can't provide guidance. That said, some contributors have successfully set up their development environment on Windows using Windows Subsystem for Linux or a Linux image in VirtualBox.

.

Repositories overview

The following repositories are ideal for contributions and contain most of the ‘help wanted’ issues:

Asking questions

  • Carefully review available materials. Most answers can be found in our extensive documentation.
  • For questions related to a specific issue and assignment requests, use the corresponding issue's comment section.
  • For general questions or development server setup troubleshooting, visit GitHub Discussions.

.

Connecting with us

  • For Google Summer of Code, including requests to join our GSoC channel during years we’re a mentoring organization, email us at [email protected]
  • For all general inquiries, including requests to join our #dev-community Slack channel, email us at [email protected].

.

.

We sincerely appreciate all our volunteers and are looking forward to being in touch with you!

Kolibri Contributors

Kolibri Contributors is a community of active volunteers who regularly collaborate with Learning Equality, receive peer support, and are often awarded public recognition for their invaluable contributions. If you’re interested in exploring becoming a Kolibri Contributor, please first review the requirements here. If you qualify, then fill out the form below and we’ll be in touch with you.