πŸš€ Version 1.1.1 is now available! Review the release notes for details.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Contribute to Sunbird Spark

Sunbird Spark is a community-maintained open-source project. Contributions in any form are welcome β€” code, documentation, testing, design, and community engagement are all equally valued.

Contribution areas

πŸ› Bug reports

File an issue on the relevant GitHub repository

πŸ’‘ Feature proposals

Start a discussion in the community forum, then file an issue after alignment

πŸ”§ Code β€” bug fixes

Fork the repository, fix the bug, submit a PR

πŸš€ Code β€” new features

Align with the community first (discussion forum), then implement and submit a PR

πŸ“ Documentation

Edit any page using the "Edit on GitHub" link at the bottom of each page

πŸ§ͺ Testing

Join the release testing process β€” contact the community QA team

🌍 Translation / I18N

Contribute language files via the I18N repository

First-time contributor guide

1. Pick a good first issue

Look for issues labelled good first issue or help wanted in the GitHub repositories:

2. Set up your local development environment

Follow the Developer Guide β€Ί Local Setup to get the full stack running locally.

3. Make your change and write tests

All contributions require:

  • Code changes that address the issue

  • Unit tests covering the changed code

  • Test results documented in the PR description

4. Submit a pull request

Open a PR against the main branch of the relevant repository. Include:

  • A reference to the issue your PR addresses

  • A description of what you changed and why

  • Test cases and results

  • Any migration steps required

5. QA validation

Once your PR is merged, the community QA team validates your change as part of the next release testing cycle. You are expected to be available to fix issues found during QA within the release timeline.

Contribution workflow

Community discussion β†’ Issue created β†’ Development β†’ PR submitted β†’

Code review β†’ QA validation β†’ Release sign-off β†’ Merged to release

If your contribution is not completed before the release cutoff, the changes will be reverted from the release branch. A fresh PR can be submitted for the next release cycle. This policy ensures release quality.

Community forums

Last updated

Was this helpful?