Create standards cheatsheet

[rgilman]

We need to gather up all of the standards we've discussed in Game Plan for CI Web Dev/Ops and BFCom style guide (and anywhere else).

It would be great to have a summary cheatsheet at least of the main points.

Here's a start on gathering the standard but not really a cheatsheet yet (which will need more specifics):

• Code – we are following the WordPress Coding Standards. Specifics from this will guide our editorconfig. This WordPress Coding Standards repo has support for PHP code sniffing, StyleLint and ESLint.
• PHP functions – Function names are all lowercase with words joined by underscores. Prefix each function with bfc_, e.g. bfc_something_cool ().
• PHP files – These are all lowercase with words joined by hyphens. New files should get a bfc- prefix. Modified existing files (e.g. buddypress template files) should keep their original names.
• CSS selectors – These are also all lowercase with words joined by hyphens. When constructing names, make them meaningful and, where appropriate, use the block-element-modifier form (see BEM 101 - CSS-Tricks and http://getbem.com). Useful guidance overall is provided in Combining the Powers of SEM and BIO for Improving CSS. Fun takes on specificity at http://batificity.com/ and https://specifishity.com/ .

I'll start by creating a google doc that we can all contribute to and comment on.

[iangilman]

Sounds good.

BTW, your markup links are broken... you don't need the url part.

[rgilman]

I've started this at CI Web DevOps Standards Cheatsheet. Please take a look. In the text I ask for comments but you here should also feel free to just add things.

@iangilman, thanks – fixed.

[rgilman]

One of the standards for PHP that's news to me is to end each file with a blank new line. It's just a warning but recommended. My git client Tower is flagging this.

[iangilman]

The cheat sheet looks good; I've added some comments.

The newline at the end of each file is a UNIX thing, and its part of Git in general; nothing to do with PHP specifically. We'll set our editors up to take care of this automatically.