is a simple tooltip library (but written as a pure CSS resource without JavaScript).
| CONTRIBUTING.md (hint.css-2.6.0) | : | CONTRIBUTING.md (hint.css-2.7.0) |
|---|
| **Hint** is written in [SASS](http://sass-lang.com/). | | **Hint** is written in [SASS](http://sass-lang.com/). |
| | |
|
| #Setup | | # Setup |
| 1. [Fork **Hint.css**](https://help.github.com/articles/fork-a-repo) and clone i
t on your system. | | 1. [Fork **Hint.css**](https://help.github.com/articles/fork-a-repo) and clone i
t on your system. |
| 2. Create a new branch out off `master` for your fix/feature. `git checkout new-
feature master` | | 2. Create a new branch out off `master` for your fix/feature. `git checkout new-
feature master` |
| | |
|
| #Building | | # Building |
| | |
| **Hint.css** uses [Grunt](http://gruntjs.com/) for the build process which you n
eed to have installed on your system. | | **Hint.css** uses [Grunt](http://gruntjs.com/) for the build process which you n
eed to have installed on your system. |
| | |
| Also there are four additional Grunt tasks required to build the library: | | Also there are four additional Grunt tasks required to build the library: |
| | |
| 1. [grunt-contrib-cssmin](https://npmjs.org/package/grunt-contrib-cssmin) | | 1. [grunt-contrib-cssmin](https://npmjs.org/package/grunt-contrib-cssmin) |
| | |
| 2. [grunt-sass](https://www.npmjs.com/package/grunt-sass) | | 2. [grunt-sass](https://www.npmjs.com/package/grunt-sass) |
| | |
| 3. [grunt-contrib-concat](https://www.npmjs.com/package/grunt-contrib-concat) | | 3. [grunt-contrib-concat](https://www.npmjs.com/package/grunt-contrib-concat) |
| | |
| 4. [grunt-contrib-watch](https://www.npmjs.com/package/grunt-contrib-watch) | | 4. [grunt-contrib-watch](https://www.npmjs.com/package/grunt-contrib-watch) |
| | |
| To install all the dependencies, run `npm install`. | | To install all the dependencies, run `npm install`. |
| | |
| Once you have the dependencies installed, run `grunt` from the project directory
. This will run the default grunt task which compiles the SCSS files into `hint.
css` file. | | Once you have the dependencies installed, run `grunt` from the project directory
. This will run the default grunt task which compiles the SCSS files into `hint.
css` file. |
| | |
| Though this should be sufficient for building the library for testing, in case y
ou want to build the minified version as well you can run the `grunt deploy` com
mand instead. | | Though this should be sufficient for building the library for testing, in case y
ou want to build the minified version as well you can run the `grunt deploy` com
mand instead. |
| | |
|
| #Things to remember | | # Things to remember |
| - 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. | | - 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. |
| | |
| - For every new modifier (example `hint--success`, `hint--top`) added, make a se
parate file unless it fits into a current modifier file. | | - For every new modifier (example `hint--success`, `hint--top`) added, make a se
parate file unless it fits into a current modifier file. |
| | |
| - Before submitting a patch, rebase your branch on upstream `master` to make lif
e easier for the merger. | | - Before submitting a patch, rebase your branch on upstream `master` to make lif
e easier for the merger. |
| | |
| - **DO NOT** add the library builds (`hint.css` & `hint.min.css`) in your commit
s. | | - **DO NOT** add the library builds (`hint.css` & `hint.min.css`) in your commit
s. |
| | |
|
| #Stay in touch | | # Stay in touch |
| | |
| To catch all updates and discussion, join the mailing list: **hintcss@googlegrou
ps.com**. | | To catch all updates and discussion, join the mailing list: **hintcss@googlegrou
ps.com**. |
| | |
| To subscribe: **hintcss+subscribe@googlegroups.com** or visit [here](https://gro
ups.google.com/forum/?fromgroups=#!forum/hintcss). | | To subscribe: **hintcss+subscribe@googlegroups.com** or visit [here](https://gro
ups.google.com/forum/?fromgroups=#!forum/hintcss). |
| | | |
| End of changes. 4 change blocks. |
|---|
| 4 lines changed or deleted | | 4 lines changed or added |
|---|
"Fossies" - the Fresh Open Source Software Archive 