Skip to content

The Reviewing Process

Jump to bottom
Dan Lawrence edited this page Feb 17, 2023 · 4 revisions

The reviewing process

For your pull request to be merged into the main branch of Pygame Community Edition, and thus make it into future releases, it must first pass the reviewing process. There are three main hurdles to pass:

  1. Your Pull request must obtain the green tick from the Automated Continuous Integration testing. This usually take about 40 minutes to do a full run, failures are noted with the red X of disappointment. You can click on failed testing runs to see if you can work out why the test failed.

  2. You must obtain a minimum of two approving reviews from the team of officially designated pygame-ce contributors. The more reviews the better, but two is the minimum.

  3. You must obtain at least one review of your minimum two from the smaller pool of experienced reviewers These reviewers have been around the metaphorical pygame-ce block and have seen many PRs come and go. If you also produce many PR reviews you could be among their number.

Other notes & tips

  • You can't review your own pull request.

  • When to merge? - Other than, does the CI pass? and, does it have enough reviews? I'd say this depends on several factors:

    • the size of the PR
    • number of reviews
    • does it add new API?

    Smaller PRs can generally be merged much more quickly, PRs that affect only comments, style or documentation generally aren't worth that much debate over. However, if somebody has added an entire new submodule; maybe give it a couple of weeks to accumulate opinions.

Clone this wiki locally