You SHOULD name all of your classes so they are sensible and are not specific to the content

Clicksco / Front-End

Organisation Front End Documentation & Tooling

http://docs.clicksco.com/frontend

2 stars 1 forks source link

You SHOULD name all of your classes so they are sensible and are not specific to the content #36

Closed BenjaminRCooper closed 10 years ago

BenjaminRCooper commented 10 years ago

Classes do not have any impact on semantics.

You SHOULD use the following to name your classes;

Make it sensible, readable and understandable to yourself and the team
it MUST NOT be specific to the styling or content of the component
Make it future proof

Don't worry about the length of the class name, the main thing is that it makes sense and it is understandable to yourself and the team

lewismorris commented 10 years ago

markgoodyear commented 10 years ago

Say for something like site-head, I've seen it being shortened to something like site-hd. Similarly with footer. Would you say use a full word for readability too? Helps if new people jump on a project and wonder what all the short names are :)

BenjaminRCooper commented 10 years ago

That would be me ha! I originally used this as it was an approach Nicole Sullivan used throughout her OOCSS resources.

I think we should stick to full words, like you say.

lewismorris commented 10 years ago

+1 on the full words, find it a million times easier.

BenjaminRCooper commented 10 years ago

My bad.

ampersarnie commented 10 years ago

+1 for full and sensible words.

timgale commented 10 years ago

Abbreviations such as ct for example can be ambiguous.

BenjaminRCooper commented 10 years ago

Implemented.