Skip to content
Permalink
Newer
Older
100644 42 lines (22 sloc) 1.95 KB
Feb 23, 2013
1
**Hint** is written in [SASS](http://sass-lang.com/).
3
# Setup
Feb 23, 2013
5
1. [Fork **Hint.css**](https://help.github.com/articles/fork-a-repo) and clone it on your system.
6
2. Create a new branch out off `master` for your fix/feature. `git checkout new-feature master`
8
# Building
Feb 23, 2013
10
**Hint.css** uses [Grunt](http://gruntjs.com/) for the build process which you need to have installed on your system.
12
Also there are four additional Grunt tasks required to build the library:
14
1. [grunt-contrib-cssmin](https://npmjs.org/package/grunt-contrib-cssmin)
Feb 23, 2013
15
16
2. [grunt-sass](https://www.npmjs.com/package/grunt-sass)
18
3. [grunt-contrib-concat](https://www.npmjs.com/package/grunt-contrib-concat)
19
20
4. [grunt-contrib-watch](https://www.npmjs.com/package/grunt-contrib-watch)
21
Feb 23, 2013
22
To install all the dependencies, run `npm install`.
24
Once you have the dependencies installed, run `npm run dev` from the project directory. This will start watching all the files in `src/` and run the default grunt task which compiles the SCSS files into `hint.css` file. You can then test your changes in `demo.html`.
26
Though this should be sufficient for building the library for testing, in case you want to build the minified version as well you can run the `grunt deploy` command instead.
27
28
# Things to remember
29
Feb 23, 2013
30
- Do not fix multiple issues in a single commit. Keep them one thing per commit so that they can be picked easily incase only few commits require to be merged.
32
- For every new modifier (example `hint--success`, `hint--top`) added, make a separate file unless it fits into a current modifier file.
33
34
- Before submitting a patch, rebase your branch on upstream `master` to make life easier for the merger.
35
36
- **DO NOT** add the library builds (`hint.css` & `hint.min.css`) in your commits.
37
38
# Stay in touch
39
40
To catch all updates and discussion, join the mailing list: **hintcss@googlegroups.com**.
41
42
To subscribe: **hintcss+subscribe@googlegroups.com** or visit [here](https://groups.google.com/forum/?fromgroups=#!forum/hintcss).