How to contribute?
There are many things you can do to contribute SassDoc:
- Report a bug;
- Fix a bug or implement a new feature;
- Suggest a new feature;
- Improve the documentation.
Asking a question
Please, do not open an issue only to ask a question; it is not the best place for this. First, make sure your question is not already answered in the documentation, especially in the Frequently Asked Questions section.
If it’s not, you can leave your question on:
If you need a quick reply or don’t feel really comfortable with asking on a public channel, try getting in touch with us on Twitter when possible: @SassDoc_, the official account.
Filling a bug
So you think you’ve found a bug? Likely. We’re all humans after all! Before even opening an issue, you have to know how SassDoc is architectured so you can submit an issue in the accurate repository:
- Core: Main API
- Theme: Theme, templates and styles
- Extras: Extra tools for theme authors
- Grunt plugin: Grunt integration
- Gulp plugin: Gulp integration
- Broccoli plugin: Broccoli integration
- Yeoman theme generator: theme generator
- Site: SassDoc’s site
- Syntax converter: Sass to SCSS converter and the like
- Blank theme: Blank theme
Please give GitHub’s search a try first, to make sure someone didn’t already submit something similar. If what you’ve found seems unique, be sure to open an issue in the appropriate repository with a clear title and a description as complete as possible.
Tip! Avoid titles like "it doesn't work", "please help me", or "bug with sassdoc". It doesn't help much understanding the problem at first glance.
Similarly, be as descriptive as possible within your description. If you have a stack trace, post it. If you can make a screenshot, even better! Explain the problem and how you got there so we can reproduce it. Only then we’ll be able to investigate.
--debug CLI flag is really helpful to gather some context to ease debugging. When not using CLI, you can always set
SASSDOC_DEBUG=1 environment variable (e.g.
SASSDOC_DEBUG=1 grunt when using Grunt).
Submitting a pull request
Want to contribute? Awesome!
If it’s a little something like typo, styles or wording, feel free to jump on it and submit a pull request; chances are high it will be quickly merged.
If you are thinking of something a bit more complex, be sure to talk with someone from the team before even starting coding in order to avoid any useless work. Also be sure to read our code guidelines.
New features or sizeable refactors should be based on the
develop branch while bugfixes should head into both
Anyway, thank you very much for contributing!