Contributing to gruvbox for Sublime Text
Contributions are always welcome. Before contributing please search the issue tracker; your issue may have already been discussed or fixed in
develop. To contribute, fork gruvbox, commit your changes, & send a pull request to the
Feature requests should be submitted in the issue tracker, with a description of
the expected behavior, where they’ll remain closed until sufficient interest, e.g.
For additions or bug fixes you should only need to modify the
*.js files under the
Do not edit the
.sublime-settingsfiles directly as your changes will not be retained on the next build
To build the themes, schemes, and widgets you will need Node.js
- Install the dependencies with
./.gulp/build.jswith Node to build everything
Usage: build [options] Options: -h, --help output usage information -t, --theme Build Themes -s, --scheme Build Schemes -w, --widget Build Widgets
Optionally, you can use gulp to ease the build process. You will need to have gulp installed globally.
The following gulp tasks are available:
gulpruns the default
./.gulp/*.jsand builds everything on change.
gulp build_themesbuilds theme
gulp build_schemesbuilds color scheme
gulp build_widgetsbuilds widget
gulp build_allbuilds themes, schemes, and widgets
gulp build_iconsbuilds file-type icon
gulp buildbuilds themes, schemes, widgets, and icons
Navigating the Files
./.gulp/build.jsthe main script which builds themes, schemes, and widgets
./.gulp/icons.jsscript which creates
.tmPreferencesfor all icons in
./.gulp/components/*.jscontains all the
./.gulp/scheme.jscontains all the
./.gulp/widget.jscontains all the
In addition to the following guidelines, please follow the conventions already established in the code.
Guidelines are enforced using JSCS:
$ npm run style