search

DEFRA / software-development-standards

Standards and guidance relating to software development in Defra
https://defra.github.io/software-development-standards/
Other
47 stars 17 forks source link

Add general guidance on writing code #20

Closed Cruikshanks closed 4 years ago

Cruikshanks commented 5 years ago

In PR #12 @Qbtron22 created some documents to cover security guidance, principles and standards. The feedback from @DEFRA/sds-group was that this was great, just they felt the guidance had a wider scope than just security.

So this PR takes the guidance document and adds it as general guidance on writing code. In fact because it is so applicable to most things it embeds it in the guidance section's main README.

🏆 All credit to @Qbtron22 for pulling together the original guidance 🏆

irisfaraway commented 4 years ago

My preference is for stuff like Rubocop over auto-formatting tools, so that may be more controversial 😄

I think as far as local development goes, devs should feel free to use whatever tool they want to get correctly formatted code, as long as they're happy with it and it fits their workflow.

Automated linting checks during CI is another matter, but maybe out of scope for this.