From 6977f30ce8d3d61998180cfcb1df3031cd91452d Mon Sep 17 00:00:00 2001 From: Anton Gilgur Date: Wed, 29 Jun 2022 01:41:18 -0400 Subject: [PATCH] github: add a Pull Request template (#370) - keeping it short and simple for now, but this is basically the format that the majority of my PRs follow - can add more sections or optional sections as needed in the future - this should help keep PRs consistent, which makes them easier to read and review - (similar rationale as that for code style consistency) - should also help preserve the historical context and rationale behind PRs - which also makes reviews _significantly_ easier and involve less guesswork - which can be very important for figuring out the intent of code - which can be particularly important when trying to decipher if a piece of code was written intentionally for a specific purpose, or accidentally has a bug in it, or is redundant, etc - while comments serve a similar function, not all code is commented and the overall purpose of a PR may not necessarily fit into any line of the code - or it may only be relevant historically, and not necessarily relevant to a piece of code's current functionality - etc etc etc etc - also requests a small bar of quality from PR authors as well --- .github/pull_request_template.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..7838ec4 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,12 @@ +## Summary + + + +## Details + +