July 11th, 2014, 5:08 pm
QuoteOriginally posted by: outrun"HERE BE DRAGONS"I'm currently helping out at a bank with a propper independent validation team. The team asks for docs, makes 300 remakes when they're done with the model-, tests-, docs- and code-review after 4 months, and it won't get into production before *all* remarks are adresses during all iterations.Their first remark in this case would be: can you remove that dragon ASCI ART and document what goes on below?Sadly I'm my own validation team (seriously where do these banks get the headcount and viable candidates for stuff like that?).QuoteOriginally posted by: PolterR20: "Names should be pronounceable. It is hard to discuss something that cannot be pronounced."QuoteOriginally posted by: outrunAnother handy practice is to add good descriptions about the changes you've made when committing to a repository.I put both of these in our style guide, well it says you should not use shorthand variable names (vi, vj, vk blah blah) and aim for readability.Commits with only "Update" as comment means I will yell at you. Normal for us is "[Library Component or project] - Description of change [Pair programming initials where applicable]"
Last edited by
Hansi on July 10th, 2014, 10:00 pm, edited 1 time in total.