git.roojs.org Git - bootswatch/blob - bower_components/font-awesome/CONTRIBUTING.md

   1 # Contributing to Font Awesome
   2
   3 Looking to contribute something to Font Awesome? **Here's how you can help.**
   4
   5
   6
   7 ## Reporting issues
   8
   9 We only accept issues that are icon requests, bug reports, or feature requests. Bugs must be isolated and reproducible problems that we can fix within the Font Awesome core. Please read the following guidelines to ensure you are the paragon of bug reporting.
  10
  11 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.
  12 2. **Create an isolated and reproducible test case.** Be sure the problem exists in Font Awesome's code with a [reduced test case](http://css-tricks.com/reduced-test-cases/) that should be included in each bug report.
  13 3. **Include a live example.** Make use of jsFiddle, jsBin, or Codepen to share your isolated test cases.
  14 4. **Share as much information as possible.** Include operating system and version, browser and version, version of Font Awesome, etc. where appropriate. Also include steps to reproduce the bug.
  15
  16
  17
  18 ## Key branches
  19
  20 - `master` is the latest, deployed version (not to be used for pull requests)
  21 - `gh-pages` is the hosted docs (not to be used for pull requests)
  22 - `*-wip` branches are the official work in progress branches for the next releases. All pull requests should be submitted against the appropriate branch
  23
  24
  25
  26 ## Notes on the repo
  27
  28 As of v3.2.0, Font Awesome's CSS, LESS, SCSS, and documentation are all powered by Jekyll templates and built before each commit and release.
  29 - `_config.yml` - much of the site is driven off variables from this file, including Font Awesome and Bootstrap versions
  30 - `src/` - All edits to documentation, LESS, SCSS, and CSS should be made to files and templates in this directory
  31 - `src/icons.yml` - all LESS, SCSS, and CSS icon definitions are driven off this single file
  32
  33
  34
  35 ## Pull requests
  36
  37 - Submit all pull requests against the appropriate `*-wip` branch for easier merging
  38 - Any changes to the docs must be made to the Liquid templates in the `src` directory
  39 - CSS changes must be done in .less and .scss files first, never the compiled files
  40 - If modifying the .less and .scss files, always recompile and commit the compiled files
  41 - Try not to pollute your pull request with unintended changes--keep them simple and small
  42 - Try to share which browsers your code has been tested in before submitting a pull request
  43
  44
  45
  46 ## Coding standards: HTML
  47
  48 - Two spaces for indentation, never tabs
  49 - Double quotes only, never single quotes
  50 - Always use proper indentation
  51 - Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags)
  52
  53
  54
  55 ## Coding standards: CSS
  56
  57 - Adhere to the [Recess CSS property order](http://markdotto.com/2011/11/29/css-property-order/)
  58 - Multiple-line approach (one property and value per line)
  59 - Always a space after a property's colon (.e.g, `display: block;` and not `display:block;`)
  60 - End all lines with a semi-colon
  61 - For multiple, comma-separated selectors, place each selector on it's own line
  62 - 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)
  63
  64
  65
  66 ## License
  67
  68 By contributing your code, you agree to license your contribution under the terms of the MIT License:
  69 - http://opensource.org/licenses/mit-license.html
  70
  71
  72
  73 ## Thanks
  74
  75 Thanks to Bootstrap for their wonderful CONTRIBUTING.MD doc. It was modified to create this one.