How to: community review

The TokTok review process requires at least three reviews for every pull request. One of the reviews must be from a developer. The two other reviews can be from a developer but can also be from the community. The idea is that the community, i.e. the Tox/TokTok users, can have direct influence on how the code and surrounding elements evolve. This page explains to a new GitHub user how to engage in a community review.

Step 1: Look over the PR list

Take a look at the pulls page on this website. It lists all the repositories that currently have open pull requests.

You can start by reading through the PR titles and see if anything catches your interest. You can also just randomly click on some PR numbers and enter the review. Everyone is allowed to review any number of PRs they like. You can post review comments and engage in discussions. You are welcome, and we will be happy to learn about any questions, concerns, or thougths you’d like to express.

Step 2: Log in to Reviewable

Step 2

Step 3

Step 3

Step 4

When you are done with a file, click the eye symbol in the corner. This marks the file as reviewed. Even if you have put comments on it, still mark it as reviewed, which just means that you saw it. It does not mean that you consider the file OK. Your comments need to be explicitly marked resolved by you clicking the ACKNOWLEDGE button.

Step 4

Step 5

As a last step, after having all files reviewed, click the PUBLISH button on the top right of the UI, marked in the image below.

You can show the File Matrix to see whether you have reviewed all the files.

The red “1” next to the speech bubbles means that there are some comments that need your attention. Click on the speech bubbles button to see them. Clicking on it again will show you the next comment and eventually wraps back to the first one.

Step 5

For each comment, you can either write a reply yourself, or simply press the ACKNOWLEDGE button to mark them as seen.

Acknowledge

Alternative: mark all files as reviewed

Instead of marking each individual file as reviewed, you can also simply review all files and then click the MARK AS REVIEWED button at the top to mark all files as reviewed at once.

Mark as reviewed

That’s all, folks

Now you’ve done a community review! Well done :) and thank you very much for helping us maintain our transparency and quality standards. If you have any questions, don’t hesitate to ask.