Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: fix typos

...

Info
titleOptional: Tips to pass review quickly

Ask commiter committer to review changes directly.


Check affected files git history to find person most likely able to review changes.

In case it's hard to determine who's able to review by git history use maintainers list presented above.


Add "review request" comment to the Jira Issue starting with a commiter committer username.

for example: "[~avinogradov], Please review my changes."


Commiter committer will gain notification and review your changes and/or help to find another commiter committer to do this.

Reviewing a Ticket

  • Make sure that your patch satisfies Review Checklist rules.
  • Each comment should be started with [~username] to guarantee proper notification.
  • Commiter committer should add comment like "Changes accepted and ready to be merged." once review successfully finished.
  • If the commitercommitter/contributor has proposals, it is recommended to add a comment in the ticket in addition to PR / CR comments referring proposals added. This helps other committers to identify that fix has something to improve.

...

Exceptions to this rule are rare and made on a case-by-case basis. For example trivial change may be merged by comitter committer without review.

Closing a Ticket

...

Normally, project repo should contain only master branch, very few branches for ongoing releases and commitercommitter's branches ready to be reviewed. Committers and PMC members are in charge to make everyone follow this rule.

...

There are several ways how you can make contribution

  • GitHub pull-request
  • Ticket Branch (only committers)

Create GitHub pull-request

...

Branch can be merged to master on sucessful successful review by at least one another committer.

...