diff --git a/docs/guidelines-general.md b/docs/guidelines-general.md index 3dd339a..3f6519b 100644 --- a/docs/guidelines-general.md +++ b/docs/guidelines-general.md @@ -12,6 +12,17 @@ TBC ## What is a cross-project code review? TBC +## Why does this exist? + +Due to the nature of REG, we don't always get to directly help each other when writing code. This is an idea to make that a little better: giving an opportunity for your colleagues to look through code you've written, and suggest changes where required. As well as giving us all practice being part of code review, you get to show everyone the awesome work you've been doing, which we all want to see! + +## Who is this for? + +People in REG that want to +- practice going through the process of code review, both as a reviewee and reviewer +- get suggestions on their work when they are unsure how to proceed + - at the same time, we will all learn a lot about new frameworks, languages and ideas we've never seen in our main projects! +- build a catalogue of code examples we can look back on when thinking about best practices ## The process