diff options
| author | Mark Otto <markd.otto@gmail.com> | 2021-01-13 22:06:07 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-13 22:06:07 +0300 |
| commit | d21fb9b6276cf023f99286c2e39498990ff69895 (patch) | |
| tree | 15f40b6235ee6708dea803fdb7b3f30b789a3b02 /site/content | |
| parent | 20a9d491a2c3615d7187d29970fd0e08b71f9471 (diff) | |
Document some basic code conventions for us (#32778)
Co-authored-by: XhmikosR <xhmikosr@gmail.com>
Diffstat (limited to 'site/content')
| -rw-r--r-- | site/content/docs/5.0/extend/approach.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/site/content/docs/5.0/extend/approach.md b/site/content/docs/5.0/extend/approach.md index 552b5f29b5..32efbf541d 100644 --- a/site/content/docs/5.0/extend/approach.md +++ b/site/content/docs/5.0/extend/approach.md @@ -76,3 +76,11 @@ Specifically regarding custom CSS, utilities can help combat increasing file siz ## Flexible HTML While not always possible, we strive to avoid being overly dogmatic in our HTML requirements for components. Thus, we focus on single classes in our CSS selectors and try to avoid immediate children selectors (`>`). This gives you more flexibility in your implementation and helps keep our CSS simpler and less specific. + +## Code conventions + +[Code Guide](https://codeguide.co/) (from Bootstrap co-creator, @mdo) documents how we write our HTML and CSS across Bootstrap. It specifices guidelines for general formatting, common sense defaults, property and attribute orders, and more. + +We use [Stylelint](https://stylelint.io/) to enforce these standards and more in our Sass/CSS. [Our custom Stylelint config](https://github.com/twbs/stylelint-config-twbs-bootstrap) is open source and available for others to use and extend. + +We use [vnu-jar](https://www.npmjs.com/package/vnu-jar) to enforce standard and semantic HTML, as well as detecting common errors. |