Blame .github/CONTRIBUTING.md

Packit Service 7770af
# Contributing to LibSass
Packit Service 7770af
Packit Service 7770af
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
Packit Service 7770af
Packit Service 7770af
The following is a set of guidelines for contributing to LibSass, which is hosted in the [Sass Organization](https://github.com/sass) on GitHub.
Packit Service 7770af
These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
Packit Service 7770af
Packit Service 7770af
LibSass is a library that implements a [sass language][8] compiler. As such it does not directly interface with end users (frontend developers).
Packit Service 7770af
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.
Packit Service 7770af
But there are other ways to contribute to the progress of LibSass. All contributions are done via github pull requests.
Packit Service 7770af
Packit Service 7770af
You can also contribute to the LibSass [documentation][9] or provide additional [spec tests][10] (and we will gladly point you in the
Packit Service 7770af
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.
Packit Service 7770af
Packit Service 7770af
## Precheck: My Sass isn't compiling
Packit Service 7770af
- [ ] Check if you can reproduce the issue via [SourceMap Inspector][5] (updated regularly).
Packit Service 7770af
- [ ] Validate official ruby sass compiler via [SassMeister][6] produces your expected result.
Packit Service 7770af
- [ ] Search for similar issue in [LibSass][1] and [node-sass][2] (include closed tickets)
Packit Service 7770af
- [ ] Optionally test your code directly with [sass][7] or [sassc][3] ([installer][4])
Packit Service 7770af
Packit Service 7770af
## Precheck: My build/install fails
Packit Service 7770af
- [ ] Problems with building or installing libsass should be directed to implementors first!
Packit Service 7770af
- [ ] Except for issues directly verified via sassc or LibSass own build (make/autotools9
Packit Service 7770af
Packit Service 7770af
## Craft a meaningfull error report
Packit Service 7770af
- [ ] Include the version of libsass and the implementor (i.e. node-sass or sassc)
Packit Service 7770af
- [ ] Include information about your operating system and environment (i.e. io.js)
Packit Service 7770af
- [ ] Either create a self contained sample that shows your issue ...
Packit Service 7770af
- [ ] ... or provide it as a fetchable (github preferred) archive/repo
Packit Service 7770af
- [ ] ... and include a step by step list of command to get all dependencies
Packit Service 7770af
- [ ] Make it clear if you use indented or/and scss syntax
Packit Service 7770af
Packit Service 7770af
## My error is hiding in a big code base
Packit Service 7770af
1. we do not have time to support your code base!
Packit Service 7770af
2. to fix occuring issues we need precise bug reports
Packit Service 7770af
3. the more precise you are, the faster we can help you
Packit Service 7770af
4. lazy reports get overlooked even when exposing serious bugs
Packit Service 7770af
5. it's not hard to do, it only takes time
Packit Service 7770af
- [ ] Make sure you saved the current state (i.e. commit to git)
Packit Service 7770af
- [ ] Start by uncommenting blocks in the initial source file
Packit Service 7770af
- [ ] Check if the problem is still there after each edit
Packit Service 7770af
- [ ] Repeat until the problem goes away
Packit Service 7770af
- [ ] Inline imported files as you go along
Packit Service 7770af
- [ ] Finished once you cannot remove more
Packit Service 7770af
- [ ] The emphasis is on the word "repeat" ...
Packit Service 7770af
Packit Service 7770af
## What makes a code test case
Packit Service 7770af
Packit Service 7770af
Important is that someone else can get the test case up and running to reproduce it locally. For this
Packit Service 7770af
we urge you to verify that your sample yields the expected result by testing it via [SassMeister][6]
Packit Service 7770af
or directly via ruby sass or node-sass (or any other libsass implementor) before submitting your bug
Packit Service 7770af
report. Once you verified all of the above, you may use the template below to file your bug report.
Packit Service 7770af
Packit Service 7770af
Packit Service 7770af
[1]: https://github.com/sass/libsass/issues?utf8=%E2%9C%93&q=is%3Aissue
Packit Service 7770af
[2]: https://github.com/sass/node-sass/issues?utf8=%E2%9C%93&q=is%3Aissue
Packit Service 7770af
[3]: https://github.com/sass/sassc
Packit Service 7770af
[4]: http://libsass.ocbnet.ch/installer/
Packit Service 7770af
[5]: http://libsass.ocbnet.ch/srcmap/
Packit Service 7770af
[6]: http://www.sassmeister.com/
Packit Service 7770af
[7]: https://rubygems.org/gems/sass
Packit Service 7770af
Packit Service 7770af
[8]: http://sass-lang.com/
Packit Service 7770af
[9]: https://github.com/sass/libsass/tree/master/docs
Packit Service 7770af
[10]: https://github.com/sass/sass-spec