Create a Code Comments Standard

[deanwhitehouseHO]

Our engineering standards are the things that we expect engineers to do. Look at the 'writing a standard' standard and provide some brief information below

What is the standard you are suggesting?
A standard outlining the approach to code commenting.

What would be the benefit to the Home Office of adopting this standard?

• Improvement to knowledge sharing
• Improvement to code readability
• Improvement to developer portability between projects

How might people follow it
A non-technical process adopted within PR reviews as a way of working.

Please confirm the below

• I have looked at the writing-a-standard standard and think this would meet the standard
• I have looked through our existing standards and think this is not covered elsewhere
• I have checked through the open issues on the repository and this standard has not already been suggested