-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Hacktoberfest 2023
Oppia is excited to be joining the rest of the GitHub community in participating in this year's Hacktoberfest. This is an event where contributors will receive a free Hacktoberfest 2023 digital reward kit if they submit at least 4 valid pull requests to any GitHub-hosted repository in the month of October.
If you have any questions, feel free to ask them on GitHub Discussions.
If you’d like to see what Oppia does, download our Android app or check out our math lessons at https://www.oppia.org/learn/math! You can also read more about our mission here.
Please follow these steps to get started:
- Sign up to register for Hacktoberfest.
- Set up your local environment to contribute to Oppia.
- Find a "good first issue" to work on (see here and here).
- Fix the issue by creating some changes and sending a pull request for review, following our PR instructions.
- Go through the code review process until you receive approval and the PR gets merged.
- To earn the digital reward kit: repeat until you've submitted at least 4 pull requests!
You can also support the Oppia open source project through donations! Please see the Hacktoberfest page or our GitHub Sponsors page for more information. We truly appreciate your support!
Q: What is Hacktoberfest?
A: Hacktoberfest is an annual event across all of GitHub which is meant to encourage developers to contribute to open source projects.
Q: Must we only work on issues marked with the Hacktoberfest label?
A: Not necessarily! Any pull request will count toward your 4, even if you are fixing an issue that doesn't have the Hacktoberfest label. Issues with the Hacktoberfest label are just meant to provide some starter ideas for newcomers. Feel free to browse issues in our different team project boards to see if there is something you’d like to work on.
Q: Do pull requests need to have the Hacktoberfest label to count?
A: Nope! No information from GitHub, Digital Ocean, and Dev seems to indicate that this is necessary.
Q: Do I need to mention that I am participating in Hacktoberfest when I open my PR?
A: No, but if you mention in your PR description that you are participating in Hacktoberfest, we might be able to add the "hacktoberfest-accepted" label if your PR looks good but doesn't get through the full review process before the end of October. That said, we prefer that PRs get fully merged, so we recommend starting early!
Have an idea for how to improve the wiki? Please help make our documentation better by following our instructions for contributing to the wiki.
Core documentation
Developing Oppia
- FAQs
- Installing Oppia
- Getting started with the codebase
- Making your first PR
- Learning resources for developers
- Codebase Overview
- Coding Guidelines
- Coding style guide
- Guidelines for creating new files
- How to add a new page
- How to write frontend type definitions
- How to write design docs
- Revert and Regression Policy
- Server errors and solutions
-
Debugging
- If your presubmit checks fail
- If CI checks fail on your PR
- Finding the commit that introduced a bug
- Interpreting GitHub Actions Results
- Debugging Docs
- Debugging datastore locally
- Debugging end-to-end tests
- Debugging backend tests
- Debugging frontend tests
- Debug frontend code
- Debugging custom ESLint check tests
- Debugging custom Pylint check tests
- Debugging Stories
- Guidelines for launching new features
- Guidelines for making an urgent fix (hotfix)
- Lint Checks
- Oppia's code owners and checks to be carried out by developers
- Privacy aware programming
- Backend Type Annotations
- Bytes and string handling in Python 3
- Guidelines for Developers with Write Access to oppia/oppia
- Testing
- Release Process
Developer Reference
- Oppiabot
- Frontend
- Backend
- Translations
- Webpack
- Third-party libraries
- Extension frameworks
- Oppia-ml Extension
- Mobile development
- Mobile device testing
- Performance testing
- Build process
- Team structure
- Triaging Process
- Playbooks
- Wiki
- Past Events