Add notes on setup for contributing
This commit is contained in:
parent
76eed639c8
commit
3374300dbc
17
README.md
17
README.md
|
@ -102,6 +102,23 @@ can't be mixed, and the same number of tabs or spaces must be used throughout.
|
||||||
Contributions are welcomed, but before you get started please read the
|
Contributions are welcomed, but before you get started please read the
|
||||||
[guidelines](http://haml-lang.com/development.html#contributing).
|
[guidelines](http://haml-lang.com/development.html#contributing).
|
||||||
|
|
||||||
|
After forking and then cloning the repo locally, install Bundler and then use it
|
||||||
|
to install the development gem dependecies:
|
||||||
|
|
||||||
|
gem install bundler
|
||||||
|
bundle install
|
||||||
|
|
||||||
|
Once this is complete, you should be able to run the test suite:
|
||||||
|
|
||||||
|
rake
|
||||||
|
|
||||||
|
You'll get a warning that you need to install haml-spec, so run this:
|
||||||
|
|
||||||
|
git submodule update --init
|
||||||
|
|
||||||
|
At this point `rake` should run without error or warning and you are ready to
|
||||||
|
start working on your patch!
|
||||||
|
|
||||||
## Authors
|
## Authors
|
||||||
|
|
||||||
Haml was created by [Hampton Catlin](http://hamptoncatlin.com), the author of
|
Haml was created by [Hampton Catlin](http://hamptoncatlin.com), the author of
|
||||||
|
|
Loading…
Reference in New Issue