Skip to content

Commit b223b3a

Browse files
committed
Sync CONTRIBUTING.md with sassdoc.com/contributing
1 parent 8c4967a commit b223b3a

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,25 @@ Please, do not open an issue only to ask a question; it is not the best place fo
1515

1616
If it's not, you can leave your question on:
1717

18-
* [tlk.io/sassdoc](http://tlk.io/sassdoc)
18+
* [SassDoc on Slack](http://sassdoc.slack.com/)
1919
* [#sassdoc on freenode](http://webchat.freenode.net/)
2020

21-
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: [@SassDoc_](https://twitter.com/sassdoc_).
21+
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: [@SassDoc_](https://twitter.com/sassdoc_), the official account.
2222

2323
## Filling a bug
2424

2525
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 architected so you can submit an issue in the accurate repository:
2626

2727
* [Core](https://github.com/sassdoc/sassdoc): API (you're here)
28-
* [Theme](https://github.com/sassdoc/sassdoc-theme-light): Theme, templates and styles
28+
* [Theme](https://github.com/sassdoc/sassdoc-theme-default): Theme, templates and styles
2929
* [Extras](https://github.com/sassdoc/sassdoc-extras): Extra tools for theme authors
3030
* [Grunt plugin](https://github.com/sassdoc/grunt-sassdoc): Grunt integration
3131
* [Gulp plugin](https://github.com/sassdoc/gulp-sassdoc): Gulp integration
3232
* [Broccoli plugin](https://github.com/sassdoc/broccoli-sassdoc): Broccoli integration
33-
* [Theme generator](https://github.com/sassdoc/generator-theme-sassdoc): Yeoman theme generator
34-
* [Site](https://github.com/SassDoc/sassdoc.github.io): SassDoc's site
33+
* [Yeoman Theme generator](https://github.com/sassdoc/generator-theme-sassdoc): Theme generator
34+
* [Site](https://github.com/sassdoc/sassdoc.github.io): SassDoc's site
35+
* [Syntax converter](https://github.com/sassdoc/sass-convert): Sass to SCSS converter and the like
36+
* [Blank theme](https://github.com/sassdoc/sassdoc-theme-blank): Blank theme
3537

3638
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.
3739

@@ -48,8 +50,8 @@ Want to contribute? Awesome!
4850

4951
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.
5052

51-
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.
53+
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](GUIDELINES.md).
5254

53-
New features or sizeable refactors should be based on the `develop` branch.
55+
New features or sizeable refactors should be based on the `develop` branch while bugfixes should head into both `master` and `develop`.
5456

5557
Anyway, thank you very much for contributing!

0 commit comments

Comments
 (0)