Update CONTRIBUTING.md

This commit is contained in:
Olivier Lacan 2015-12-03 13:47:24 -05:00
parent 9186608879
commit 15dafda3cf

View File

@ -1,14 +1,7 @@
Hi there,
Please open a pull request with any suggestions you have regarding the
example [CHANGELOG](CHANGELOG.md) or the [README](README.md).
Please open a pull request with any suggestions you have.
Edit files in [`source/`](source/). Each sub-directory is a different language translation of [`source/index.haml`](source/index.haml).
Don't edit the [`index.html`](index.html) manually. Instead:
1. make changes to [README](README.md) if necessary
2. run [`generate.thor`](generate.thor) with `thor generate index`.
3. add the `README.md` and `index.html` changes to a Pull Request.
Tweaks, fixes and improvements to any of the [assets](assets/) are also
quite welcome.
You will need a maintainer to run `rake publish` for you once changes are merged in in order to update keepachangelog.com.