UKHomeOffice / engineering-guidance-and-standards

Engineering Guidance and Standards for the Home Office
https://engineering.homeoffice.gov.uk
MIT License
14 stars 2 forks source link

Create a Code Comments Standard #305

Open deanwhitehouseHO opened 8 months ago

deanwhitehouseHO commented 8 months ago

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?

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

Please confirm the below