What’s in a Guideline? Win a Copy of the Little Book of HTML/CSS Coding Guidelines!
Post from April 14, 2016 (↻ April 21, 2018), filed under Web Development.
Coding guidelines are important. Only one-man teams wouldn’t need them—and yet when working alone we should still look into working with some standards.
What we need to keep in mind around coding guidelines is pretty well-documented by now, and I’m very happy to point to e.g. styleguides.io or cssguidelin.es. And yet I myself had just the other month published The Little Book of HTML/CSS Coding Guidelines, which discusses the theory and practice of coding guidelines in some detail.
Five signed editions of the physical version of the book, now, I’ll give away for free—and even throw in an extra signed copy of The Little Book of HTML/CSS Frameworks.
To win you have until April 30 to comment here or tweet (to @j9t), why you deem coding guidelines important or what you find to be the most useful coding guideline.
I’ll check the comments and tweets for all answers and semi-randomly select the five (six) winners, and announce them on a follow-up post on this site together with their responses. The winners must then please contact me through this site so that I can send them their copies (through standard mail, for which I’ll be covering for shipping fees up to $10 each). Note that I’ll bet everything on mutual trust, and that there’s no legal entitlement, claim, regress, appeal, or whatever else there is. Good luck!
About the Author
Jens Oliver Meiert is a technical lead and author (sum.cumo, W3C, O’Reilly). He loves trying things, including in the realms of philosophy, art, and adventure. Here on meiert.com he shares and generalizes and exaggerates some of his thoughts and experiences.
If you have any thoughts or questions (or recommendations) about what he writes, leave a comment or a message.
On April 15, 2016, 15:37 CEST, Marcus Feinstein said:
Always validate your code!!
In CSS, not every property/value pair speaks for itself: think of using “overflow:auto” in order to contain the element’s floating children.
Always write comments for these ambiguous declarations, even for those mentioned ‘one-man teams’!
I don’t think validation is important but that commenting is.
On April 18, 2016, 13:14 CEST, Shay Cojocaru said:
Consistency among team members and keeping concerns separated.
For me the most important part of guidelines is to avoid future pain. It may be quick to bolt on thoughtless hacks here and there (getting the job done!) — until something trivial takes hours to find out “Where does it fit in this bloated mess?”
Plus, it is truly embarrassing if I look at my own code a couple of months (years) later and can’t remember how it works or even what it does.
On April 23, 2016, 12:45 CEST, chemlin said:
Keep on writing and chugging away!
On April 24, 2016, 8:39 CEST, Ernest D. said:
Got a little spam problem here? What are all these insurance comments about.
My favorite guideline is to indent properly.
On April 28, 2016, 8:43 CEST, Martin Cook said:
I don’t want a prize but if there’s a guideline to follow then it’s to comment. Uncommented code is the worst.