Skip to content

Maintainer Guidelines

Jump to bottom
Isabel Costa edited this page Mar 11, 2020 · 4 revisions

Guidelines

Make sure contributors are respecting the Contribution Guidelines. If they don't let them know about it: what is missing, what was disrespected?

Code Review

  • When possible get a second opinion before merging.
  • Make sure the PR has a link to the issue.
  • If you can, let them know why your change request makes sense.
  • (nice to have) If you have time, thank them for their contributing to the project.

Merging PRs

TL;DR:

  1. Select "Squash and Merge"
  2. Edit commit if necessary to follow standards and PR id

Long version:

About merging pull requests (PRs), to keep the project commit history clean, it's important to have all commits from a PR to be squashed when merging. For this you may have to select "Squash and Merge" option:

Squash and Merge option on GitHub

If the commit does not follow our Commit Message Style Guide, make sure to ask the contributor to fix it or you can fix it when merging.

Editing commit when merging

Make sure to always leave the PR identifier, so that we can traceback a commit to a specific PR.

Mentorship Backend

Documentation

GSoC Students

Clone this wiki locally