search

DEFRA / software-development-standards

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

Add example effective dates to a standard #53

Closed Cruikshanks closed 4 years ago

Cruikshanks commented 4 years ago

Some of the PR's have include discussions about ensuring teams are not penalised because they are having to work with code bases that do not follow whatever is the current latest standard as defined here.

We have discussed manually versioning our standards. Concensus however was as we are using source control, manually applying a version seems an unnecessary burden. Another solution has been to use dates. This solution also fits in with one of our current principles for standards

...all standards must define the period of time that they are effective and how they have changed over time

The problem is we don't as yet have an actual example of how to go about this. Hence this proposed change to the Java coding standard, to demonstrate (and collaborate) on an approach that can then be retroactively applied to our existing standards, and used for any new ones in the future.

ben-sagar commented 4 years ago

Thank you for this - I was thinking along very similar lines.

Cruikshanks commented 4 years ago

Having got the initial nod that this was the kind of thing @bensagar-ea was thinking of when we talked about making dates visible I'm opening this up for review!

FalloutVaultBoy commented 4 years ago

Looks good. I approve.