Skip to content
Permalink
Browse files
update contributoing
  • Loading branch information
chinchang committed Oct 3, 2021
1 parent 53b34ee commit dc22dde5ee58ddc54ef0a2fc76aca9483a950e80
Showing 1 changed file with 3 additions and 1 deletion.
@@ -1,6 +1,7 @@
**Hint** is written in [SASS](http://sass-lang.com/).

# Setup

1. [Fork **Hint.css**](https://help.github.com/articles/fork-a-repo) and clone it on your system.
2. Create a new branch out off `master` for your fix/feature. `git checkout new-feature master`

@@ -20,11 +21,12 @@ Also there are four additional Grunt tasks required to build the library:

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 `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`.

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.

# 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.

- For every new modifier (example `hint--success`, `hint--top`) added, make a separate file unless it fits into a current modifier file.

0 comments on commit dc22dde

Please sign in to comment.