Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a Code Comments Standard #305

Open
3 tasks done
deanwhitehouseHO opened this issue Oct 20, 2023 · 0 comments · May be fixed by #298
Open
3 tasks done

Create a Code Comments Standard #305

deanwhitehouseHO opened this issue Oct 20, 2023 · 0 comments · May be fixed by #298

Comments

@deanwhitehouseHO
Copy link

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
@deanwhitehouseHO deanwhitehouseHO linked a pull request Oct 20, 2023 that will close this issue
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant