www.aleph1.co.uk Git - yaffs-website/blob - web/themes/contrib/bootstrap/docs/Contributing.md

   1 <!-- @file Overview on how to contribute to the Drupal Bootstrap project. -->
   2 <!-- @defgroup -->
   3 # Contributing
   4
   5 Please read the @link faq FAQ @endlink and @link getting_started Getting Started @endlink
   6 topics first before creating an issue in this project's issue queue.
   7
   8 Anything that falls within the scope of existing documentation or answered
   9 questions will be marked as "Closed (works as designed)" or "Closed (won't fix)".
  10
  11 The [Theme development](https://drupal.org/forum/3) support forum and
  12 [Drupal StackExchange](http://drupal.stackexchange.com) are also amazing
  13 resources for asking questions, learning new techniques and overall general
  14 support.
  15
  16 ## Drupal.org Handbook Pages
  17 There has been some amazing Drupal Community work done around integration between
  18 Drupal and the [Bootstrap Framework]. Additional community driven documentation
  19 can be found on the [original Drupal.org handbook pages](https://www.drupal.org/node/1976938).
  20
  21 If you find that the documentation in these locations are inaccurate or missing,
  22 please update it yourself (all logged in users have edit capability).
  23
  24 ## Creating New Issues
  25
  26 {.alert.alert-info} **Recommended reading:** [How To Solve All Your [Drupal] Problems](http://www.lullabot.com/blog/article/how-solve-all-your-problems)
  27
  28 {.alert.alert-warning} Please, [search the issue queue](https://drupal.org/project/issues/search/bootstrap)
  29 first. **DO NOT** duplicate existing issues.
  30
  31 **If you find an existing issue and the issue status is:**
  32 - Closed (fixed, duplicate, won't fix) - **DO NOT** re-open it. Open a new
  33   issue (unless it's "Closed (won't fix)") and reference the existing issue in
  34   the "Related Issues" field.
  35 - Active, NR, NW, RTBC - Please update the issue accordingly, **DO NOT** create
  36   a new issue.
  37
  38 **The [Drupal Bootstrap] issue queue IS for:**
  39 - Fixing bugs and adding new features pertaining to the integration between
  40   Drupal and the [Bootstrap Framework].
  41
  42 **The [Drupal Bootstrap] issue queue IS NOT for:**
  43 - Bugs/feature requests pertaining to the [Bootstrap Framework] itself. Use
  44   [their issue queue](https://github.com/twbs/bootstrap/issues) instead.
  45 - Custom CSS/Layout (e.g. site specific)
  46 - LESS/SASS - Compilation errors, syntax, mixins/functions
  47 - JavaScript, jQuery, Bootstrap plugins or custom (site specific) plugins
  48 - Modules that don't work in multiple themes. File the issue with that module.
  49   It is likely they are not using [APIs](https://api.drupal.org) properly, not
  50   following existing [Coding Standards](https://drupal.org/coding-standards)
  51   or not developing with [Best Practices](https://drupal.org/best-practices) in
  52   mind. It is actually a rare event when it is a legitimate issue with the
  53   [Drupal Bootstrap] project.
  54
  55 ## IRC
  56 The [Drupal Bootstrap] project and its maintainers use the `#drupal-bootstrap`
  57 channel on the freenode.net IRC network to communicate in real time. Please read
  58 the following for more information on how to the community uses this technology:
  59 [Chat with the Drupal Community on IRC](https://www.drupal.org/irc).
  60
  61 Please keep in mind though, this **IS NOT** a "support" channel. It's primary
  62 use is to discuss issues and to help fix bugs with the base theme itself.
  63
  64 [Drupal Bootstrap]: https://www.drupal.org/project/bootstrap
  65 [Bootstrap Framework]: http://getbootstrap.com