Skip to content

Instantly share code, notes, and snippets.

View Aaron1178's full-sized avatar

Aaron Thompson Aaron1178

  • Dark Rising Studios
  • Australia
View GitHub Profile
@Aaron1178
Aaron1178 / pr_etiquette.md
Created January 12, 2024 10:33 — forked from mikepea/pr_etiquette.md
Pull Request Etiquette

Pull Request Etiquette

Why do we use a Pull Request workflow?

PRs are a great way of sharing information, and can help us be aware of the changes that are occuring in our codebase. They are also an excellent way of getting peer review on the work that we do, without the cost of working in direct pairs.

Ultimately though, the primary reason we use PRs is to encourage quality in the commits that are made to our code repositories

Done well, the commits (and their attached messages) contained within tell a story to people examining the code at a later date. If we are not careful to ensure the quality of these commits, we silently lose this ability.