rooty/Bootstrap
0
0
Fork 0
mirror of https://github.com/twbs/bootstrap.git synced 2024-11-28 10:24:19 +01:00
Code Issues Actions Packages Releases Activity

contributing edits

Browse Source
This commit is contained in:
Mark Otto 2012-09-18 11:50:11 -07:00
parent c15877445c
commit 13be8b2031
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@ -1,8 +1,10 @@
# Contributing to Bootstrap
Recommendations and requirements for how to best contribute to Bootstrap. We strive to obey these as best as possible, though we may drift as development continues in our primary development branches. As always, thanks for contributing--we hope these guidelines make it easier and shed some light on our approach and processes. Recommendations and requirements for how to best contribute to Bootstrap. We strive to obey these as best as possible, though we may drift as development continues in our primary development branches. As always, thanks for contributing--we hope these guidelines make it easier and shed some light on our approach and processes.
### Key branches ### Key branches
- `master` is the latest, deployed version - `master` is the latest, deployed version
- `*-wip` is the official branch for the next release - `*-wip` is the official work in progress branch for the next release
### Notes on the repo ### Notes on the repo
As of v2.0.0, Bootstrap's documentation is powered by Mustache templates and built via `make` before each commit and release. This was done to enable internationalization (translation) in a future release by uploading our strings to the [Twitter Translation Center](http://translate.twttr.com/). Any edits to the docs should be first done in the Mustache files and then recompiled into the HTML. As of v2.0.0, Bootstrap's documentation is powered by Mustache templates and built via `make` before each commit and release. This was done to enable internationalization (translation) in a future release by uploading our strings to the [Twitter Translation Center](http://translate.twttr.com/). Any edits to the docs should be first done in the Mustache files and then recompiled into the HTML.
@ -22,7 +24,7 @@ As of v2.0.0, Bootstrap's documentation is powered by Mustache templates and bui
- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags) - Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags)
### Coding standards: CSS ### Coding standards: CSS
- Adhere to the property order we support via Recess: http://www.markdotto.com/2011/11/29/css-property-order/ - Adhere to the [Recess CSS property order](http://markdotto.com/2011/11/29/css-property-order/)
- Multiple-line approach (one property and value per line) - Multiple-line approach (one property and value per line)
- Always a space after a property's colon (.e.g, `display: block;` and not `display:block;`) - Always a space after a property's colon (.e.g, `display: block;` and not `display:block;`)
- End all lines with a semi-colon - End all lines with a semi-colon
@ -30,5 +32,4 @@ As of v2.0.0, Bootstrap's documentation is powered by Mustache templates and bui
- Attribute selectors, like `input[type="text"]` should always wrap the attribute's value in double quotes, for consistency and safety (see this [blog post on unquoted attribute values](http://mathiasbynens.be/notes/unquoted-attribute-values) that can lead to XSS attacks). - Attribute selectors, like `input[type="text"]` should always wrap the attribute's value in double quotes, for consistency and safety (see this [blog post on unquoted attribute values](http://mathiasbynens.be/notes/unquoted-attribute-values) that can lead to XSS attacks).
### License ### License
By contributing your code, you agree to license your contribution under the terms of the APLv2: By contributing your code, you agree to license your contribution under the terms of the APLv2: https://github.com/twitter/bootstrap/blob/master/LICENSE
https://github.com/twitter/bootstrap/blob/master/LICENSE