Skip to content

Commit

Permalink
docs(CONTRIBUTING): add note (#2368)
Browse files Browse the repository at this point in the history
  • Loading branch information
kt3k authored May 17, 2018
1 parent e685efe commit aac3ce7
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ If you want to see specs running live in browser (e.g., for debugging), simply o

First you need ruby and [bundler][] to build the documentation site.

**Note:** Currently the site doesn't build with ruby 2.5.x, so you need ruby 2.4.4 or below. ([rbenv][] is useful for switching between ruby versions.)

```console
$ gem install bundler
```
Expand All @@ -66,3 +68,4 @@ Then access `http://0.0.0.0:4567`.
Add something about PRs here, indicate that PRs should not bump the version number & the build output files (`c3.js`, `c3.min.js`, `c3.css` & `c3.min.css`) should be excluded

[bundler]: https://bundler.io
[rbenv]: https://github.com/rbenv/rbenv

0 comments on commit aac3ce7

Please sign in to comment.