Skip to content

Latest commit

 

History

History
66 lines (39 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

66 lines (39 loc) · 2.99 KB
Raw

Contributing to SASS Bootstrap

Looking to contribute something to SASS Bootstrap? Here's how you can help.

Reporting issues

We only accept issues that are bug reports or feature requests. Bugs must be isolated and reproducible problems that we can fix within the Sass Bootstrap core. Please read the following guidelines before opening any issue.

  1. Search for existing issues. We get a lot of duplicate issues, and you'd help us out a lot by first checking if someone else has reported the same issue. Moreover, the issue may have already been resolved with a fix available.
  2. Create an isolated and reproducible test case. Be sure the problem exists in Bootstrap's code with a reduced test case that should be included in each bug report.
  3. Include a live example. Make use of jsFiddle or jsBin to share your isolated test cases.
  4. Share as much information as possible. Include operating system and version, browser and version, version of Sass Bootstrap, customized or vanilla build, etc. where appropriate. Also include steps to reproduce the bug.

Key branches

  • *sass-wip is the official work in progress branch for the next Sass Bootstrap release (use for pull requests).
  • master is the latest, deployed version (not to be used for pull requests).
  • gh-pages is the hosted docs (not to be used for pull requests).

Pull requests

  • CSS changes must be done in .scss files first, never just the compiled .css files
  • If modifying the .scss files, always recompile by running grunt, and commit the pre-compiled and compiled files
  • Try not to pollute your pull request with unintended changes--keep them simple and small
  • Try to share which browsers your code has been tested in before submitting a pull request
  • Pull requests should always be against the current *sass-wip branch, never against gh-pages or master

Coding standards

HTML

  • Two spaces for indentation, never tabs
  • Double quotes only, never single quotes
  • Always use proper indentation
  • Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags)

CSS

  • Adhere to the RECESS CSS property order
  • 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;)
  • End all lines with a semi-colon
  • For multiple, comma-separated selectors, place each selector on its own line
  • 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 that can lead to XSS attacks).

JS

  • No semicolons
  • Comma first
  • 2 spaces (no tabs)
  • strict mode
  • "Attractive"

License

By contributing your code, you agree to dual-license your contribution under the Apache 2 and MIT licenses.