Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

50 lines (32 loc) · 2.89 KB
Raw

Contributing

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add documentation if necessary.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Send a pull request. Bonus points for topic branches.

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported.
  2. Check if the issue has been fixed — try to reproduce it using the latest master branch in the repository.
  3. Isolate the problem — ideally create an SSCCE and a live example.
  4. Always consult the Troubleshooting guide before opening a new issue.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? Do other browsers show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

If you are facing binary related issues, please create a gist (see Creating gists on GitHub) with the output of this set of commands:

If this project is missing an API or command line flag that has been added to libsass, then please open an issue here. We will then look at updating our libsass submodule and create a new release. You can help us create the new release by rebuilding binaries, and then creating a pull request to the node-sass-binaries repo.

Testing a bugfix:

  1. Ensure the master branch is up-to-date with: git checkout master; git pull
  2. Create a new Git branch and make your changes. git checkout -b name-of-new-branch
  3. Install all the node.js dependencies of node-sass with: npm install
  4. Ensure the tests pass with: npm test

If the bug fix requires modifying any of the C++ files in the src/ directory, you'll need to re-build the bindings to libSass.

  1. Build the libSass bindings for node-sass with: npm run-script build

Alternatively, the scripts/build.js build script has several different command line flags that can be passed by running: node scripts/build.js -[flag]

Reporting Sass compilation and syntax issues

Please check for issues on the libsass repo (as there is a good chance that it may already be an issue there for it), and otherwise create a new issue there.