Skip to content

Latest commit

 

History

History
21 lines (19 loc) · 1.3 KB

github.md

File metadata and controls

21 lines (19 loc) · 1.3 KB
Raw

GitHub contributing guidelines

General

Pull Requests

Do:

  • Scope PRs to the smallest self-contained change possible.
  • Open one PR per change (for example: a feature addition and a refactor of related code are separate changes warranting separate PRs).
  • Use a descriptive title and description. Provide enough context that anyone familiar with the codebase can understand the purpose of the change and review it.
  • Include a link to a related issue if applicable.
  • Attach labels.
  • Assign reviewers if the automated reviewer assignment is insufficient.
  • Open PRs early as a draft and add the WIP label to get early feedback.
  • Rebase from master when your branch/PR is out of date.
  • Fix review feedback in individual commits with descriptive commit messages (and link these commits in the comments).

Do not:

  • Link to private issue trackers or internal documents.
  • Ask for final reviews unless CI is passing.
  • Resolve reviewer comments yourself (allow the reviewer to do so once they are satisfied that their feedback is addressed).
  • Close and open a new PR to address git conflicts or feedback (PRs are documentation. One PR per change).