...
If your change in still in progress or experimental, please open the pull request as a draft. We won’t focus on reviews until the code is ready and will reduce wasted attention on both sides.
Make sure that you describe the purpose of the change that you are proposing clearly in the description of the pull request and why the change is valuable.
Read the bot messages on your PR carefully.
Use conventional commits following the Open edX project standard.
Allow admins to push commits onto your branch. GitHub has settings that allow reviewers to push commits onto your branch. This feature is valuable when the branch is out of date with the base. Reviewers can update your branch from the base with a merge commit that will isolate those changes, but decrease the back-and-forth, which can add days to review times.
Mention related pull requests so reviewers can review them as a single body of work and avoid context shifts.
Check the checks. GitHub required that the Open edX team run checks manually for new contributors. When there are failures, please review them and address them quickly to ensure a timely completion of your review. Failures you may see include linting errors, test failures, failures related to decreased test coverage, etc. On occasion failures may not be related to your change, but can be fixed by merging in updates on the base branch. If you believe this is the case, please update your branch.
Working with GitHub Issues
Work on Open edX is often tracked on GitHub issues, which are organized on GitHub project boards.
Anyone with a GitHub account can interact with our GitHub issues in some basic ways using issue commands. For example, if you would like to work on an issue, let everyone know by simply commenting assign me !
Once you have established yourself as involved in a working group or some other project, feel free to request “Triage” access to our repositories. Open an Axim Request using the “Onboarding” template, and specify that you would like Triage access in order to be more involved in the project. Provide a link to what you’re working on, and @-mention another GitHub user who you have been working with who can vouch for you. If Axim grants the request, then you will find that you’re now able to manage assignees, labels, and handful of other aspects of Open edX GitHub issues.
Once you have Triage access, you can also ask project leaders to give you access to individual project boards that you want to help manage, which will let you change status and other metadata on project issues.
Giving Feedback
We are always looking to improve this process and make it easier for people to contribute to the platform. Your feedback is a very important part of that process.
...