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

Review technical documentation files #274

Closed edhamiltonHO closed 8 months ago

edhamiltonHO commented 9 months ago

Which content do you think should be reviewed? Documentation files in repo root, e.g. README.md, CONTRIBUTING.md, and the technical decision log

Why do you think we should review this? As part of the migration to UKHomeOffice and new hosting, a number of our files will need to be amended. Also the technical decision log will need to reflect the chance

Please confirm the below

edhamiltonHO commented 8 months ago

Needs to cover at minimum

keithkennedyHO commented 8 months ago

Make changes - do we want this to recommend forking the repo?

I am not aware of us requiring this as other repositories do so unsure here. This is not how PRs generated by guilds or development teams are working (which is fine, of course). However, for external contributors, this is a good approach to take, I think and worth suggesting.

edhamiltonHO commented 8 months ago

OK, I think leave this as is, it is not broken

Looking through though I noticed that section on raising a security vulnerability issue was out of sequence and interfering with the flow for making a change. I've added little commit to fix