This is great! Our team did something very similar and it has helped us a ton.
One additional thing we did was add links to other documents where we detail
what to look for when reviewing code
our definition of done
a specific list of gotchas we have encountered
The intent isn't that every PR must comb through all of those documents, but we all know where they are and they can guide us if we face a problem or a disagreement.
This is great! Our team did something very similar and it has helped us a ton.
One additional thing we did was add links to other documents where we detail
The intent isn't that every PR must comb through all of those documents, but we all know where they are and they can guide us if we face a problem or a disagreement.
Thanks for sharing!
thats a great idea! especially for people new to a project