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