]> git.ipfire.org Git - thirdparty/bootstrap.git/commitdiff
Document some basic code conventions for us (#32778)
authorMark Otto <markd.otto@gmail.com>
Wed, 13 Jan 2021 19:06:07 +0000 (11:06 -0800)
committerGitHub <noreply@github.com>
Wed, 13 Jan 2021 19:06:07 +0000 (21:06 +0200)
Co-authored-by: XhmikosR <xhmikosr@gmail.com>
site/content/docs/5.0/extend/approach.md

index 552b5f29b5bfeee43f63865616012f5e6fbab833..32efbf541d5ea9eee4c1a4a0b492a2da8a7c18cf 100644 (file)
@@ -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.