www.aleph1.co.uk Git - yaffs-website/blob - vendor/twbs/bootstrap-sass/CONTRIBUTING.md

   1 # Contributing to bootstrap-sass
   2
   3 ## Asset Changes
   4
   5 Any changes to `bootstrap-sass` assets (scss, javascripts, fonts) should be checked against the `convert` rake task.
   6 For usage instructions, see the [README](/README.md).
   7
   8 If something is broken in the converter, it's preferable to update the converter along with the asset itself.
   9
  10
  11 ## Bugs
  12
  13 A bug is a _demonstrable problem_ that is caused by the code in the
  14 repository. Good bug reports are extremely helpful - thank you!
  15
  16 Guidelines for bug reports:
  17
  18 1. **Does it belong here?** &mdash; is this a problem with bootstrap-sass, or
  19    it an issue with [twbs/bootstrap](https://github.com/twbs/bootstrap)?
  20    We only distribute a direct port and will not modify files if they're not
  21    changed upstream.
  22
  23 2. **Use the GitHub issue search** &mdash; check if the issue has already been
  24    reported.
  25
  26 3. **Isolate the problem** &mdash; ideally create a [reduced test
  27    case](http://css-tricks.com/6263-reduced-test-cases/) and a live example.
  28
  29 A good bug report shouldn't leave others needing to chase you up for more
  30 information. Please try to be as detailed as possible in your report. What is
  31 your environment? What steps will reproduce the issue? What browser(s) and OS
  32 experience the problem? What would you expect to be the outcome? All these
  33 details will help people to fix any potential bugs.
  34
  35 Example:
  36
  37 > Short and descriptive example bug report title
  38 >
  39 > A summary of the issue and the browser/OS environment in which it occurs. If
  40 > suitable, include the steps required to reproduce the bug.
  41 >
  42 > 1. This is the first step
  43 > 2. This is the second step
  44 > 3. Further steps, etc.
  45 >
  46 > `<url>` (a link to the reduced test case)
  47 >
  48 > Any other information you want to share that is relevant to the issue being
  49 > reported. This might include the lines of code that you have identified as
  50 > causing the bug, and potential solutions (and your opinions on their
  51 > merits).
  52
  53 **[File a bug report](https://github.com/twbs/bootstrap-sass/issues/)**
  54
  55
  56 ## Pull requests
  57
  58 **We will not accept pull requests that modify the SCSS beyond fixing bugs caused by *our* code!**
  59
  60 We use a [converter script][converter-readme] to automatically convert upstream bootstrap, written in LESS, to Sass.
  61
  62 Issues related to styles or javascript but unrelated to the conversion process should go to [twbs/bootstrap][upstream].
  63
  64 Pull requests that fix bugs caused by our code should not modify the SCSS directly, but should patch the converter instead.
  65
  66 Good pull requests - patches, improvements, new features - are a fantastic
  67 help. They should remain focused in scope and avoid containing unrelated
  68 commits. If your contribution involves a significant amount of work or substantial
  69 changes to any part of the project, please open an issue to discuss it first.
  70
  71 Make sure to adhere to the coding conventions used throughout a project
  72 (indentation, accurate comments, etc.). Please update any documentation that is
  73 relevant to the change you're making.
  74
  75 ## Do not…
  76
  77 Please **do not** use the issue tracker for personal support requests (use
  78 [Stack Overflow](http://stackoverflow.com/)).
  79
  80 Please **do not** derail or troll issues. Keep the
  81 discussion on topic and respect the opinions of others.
  82
  83 *props [html5-boilerplate](https://github.com/h5bp/html5-boilerplate/blob/master/CONTRIBUTING.md)*
  84
  85 [upstream]: https://github.com/twbs/bootstrap
  86 [converter-readme]: https://github.com/twbs/bootstrap-sass/blob/master/README.md#upstream-converter