Skip to content
This repository has been archived by the owner on Nov 1, 2021. It is now read-only.

Core contributor guide

Drew DeVault edited this page Apr 26, 2018 · 14 revisions

Welcome to the project! Please read this scatterbrained collection of wisdom gathered by other core contributors.

Golden rules

  • Breaking the rules is okay, but only if you are prepared to justify it to everyone else (and they agree with you).
  • Edit this wiki page

Submitting your patches

Avoid merging or directly committing your own patches, unless they're small and limited to documentation or something.

Triaging patches

If you see a patch which doesn't have any reviewers assigned (including ones you submit yourself): triage it. Add some labels if you like, and assign some reviewers. Follow these steps until you have a number of reviewers proportional to the complexity of the change:

  1. Assign @SirCmpwn
  2. Assign people who work a lot in the domain of the patch
  3. Assign a selection from everyone else with a roughly even distribution

If you get assigned to a patch you don't think is in your domain and/or you don't have time to review, assign someone else.

Reviewing patches

  • Don't be too shy to complain about code style issues
  • Ask for a test plan if you don't know how to test it

Merging patches

  • If it's small-to-medium and in your domain, merge it whenever you feel comfortable with it
  • If it's medium-to-large, merge it when it has 2 approving reviews
  • If it's large-to-huge, @SirCmpwn will merge it
Clone this wiki locally