Text Blame History Raw

Contributing to LibSass

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing to LibSass, which is hosted in the Sass Organization on GitHub. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

LibSass is a library that implements a sass language compiler. As such it does not directly interface with end users (frontend developers). For direct contributions to the LibSass code base you will need to have at least a rough idea of C++, we will not lie about that. But there are other ways to contribute to the progress of LibSass. All contributions are done via github pull requests.

You can also contribute to the LibSass documentation or provide additional spec tests (and we will gladly point you in the direction for corners that lack test coverage). Foremost we rely on good and concise bug reports for issues the spec tests do not yet catch.

Precheck: My Sass isn't compiling

  • [ ] Check if you can reproduce the issue via SourceMap Inspector (updated regularly).
  • [ ] Validate official ruby sass compiler via SassMeister produces your expected result.
  • [ ] Search for similar issue in LibSass and node-sass (include closed tickets)
  • [ ] Optionally test your code directly with sass or sassc (installer)

Precheck: My build/install fails

  • [ ] Problems with building or installing libsass should be directed to implementors first!
  • [ ] Except for issues directly verified via sassc or LibSass own build (make/autotools9

Craft a meaningfull error report

  • [ ] Include the version of libsass and the implementor (i.e. node-sass or sassc)
  • [ ] Include information about your operating system and environment (i.e. io.js)
  • [ ] Either create a self contained sample that shows your issue ...
  • [ ] ... or provide it as a fetchable (github preferred) archive/repo
  • [ ] ... and include a step by step list of command to get all dependencies
  • [ ] Make it clear if you use indented or/and scss syntax

My error is hiding in a big code base

  1. we do not have time to support your code base!
  2. to fix occuring issues we need precise bug reports
  3. the more precise you are, the faster we can help you
  4. lazy reports get overlooked even when exposing serious bugs
  5. it's not hard to do, it only takes time - [ ] Make sure you saved the current state (i.e. commit to git) - [ ] Start by uncommenting blocks in the initial source file - [ ] Check if the problem is still there after each edit - [ ] Repeat until the problem goes away - [ ] Inline imported files as you go along - [ ] Finished once you cannot remove more - [ ] The emphasis is on the word "repeat" ...

What makes a code test case

Important is that someone else can get the test case up and running to reproduce it locally. For this we urge you to verify that your sample yields the expected result by testing it via SassMeister or directly via ruby sass or node-sass (or any other libsass implementor) before submitting your bug report. Once you verified all of the above, you may use the template below to file your bug report.