diff options
| author | Peter Gumeson <gumeson@gmail.com> | 2013-05-30 11:25:02 +0400 |
|---|---|---|
| committer | Peter Gumeson <gumeson@gmail.com> | 2013-05-30 11:25:02 +0400 |
| commit | e6e0cd2bad6769f6a7da3ede5333f4d40799be58 (patch) | |
| tree | 84cddc3df74fad0ff0ad9103063983dba73fe90c /CONTRIBUTING.md | |
| parent | eb5b39ca2f69f6f8fcf10ef32e6d5f2ff08876a7 (diff) | |
Moved converter instructions into readme
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 17 |
1 files changed, 4 insertions, 13 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d63f874..e2d14ced 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,20 +1,11 @@ # Contributing to bootstrap-sass -## Upstream Converter +## Asset Changes -Upsteam changes to the Twitter Bootstrap project can be pulled in using the `convert` rake task. +Any changes to `bootstrap-sass` assets (scss, javascripts, fonts) should be checked against the `convert` rake task. +For usage instructions, see the [README](https://github.com/intridea/bootstrap-sass/edit/3.0.0-wip/README.md). -Here's an example run that would pull down the `3.0.0-wip` branch from the main twitter/bootstrap repo: - - % bundle exec rake 'convert[3.0.0-wip]' - -The latest converter script is located [here](https://github.com/intridea/bootstrap-sass/blob/3.0.0-wip/tasks/converter.rb) and attempts to do the following: - -* Convert upsteam bootstrap Less files to the matching Scss file. -* TODO: Copy upstream javascript, images and other assets into the bootstrap-sass assets directory. - -This conversion is not perfect at this time so manual fixes to the resulting Scss will necessary. -See [these github issues](https://github.com/intridea/bootstrap-sass/issues?labels=converter&state=open) tagged with `conversion` which track the current shortcomings of the conversion process. +If something is broken in the converter, it's preferable to update the converter along with the asset itself. ## Bugs |