Skip to content

Commit 447bf43

Browse files
committed
Revamp the "Contributing" guide in the README
I tried to describe more thoroughly the process of contributing to the website. I also updated the guide in order to use `bundle install` and `bundle exec jekyll [cmd]` now that a Gemfile is present.
1 parent c5c104f commit 447bf43

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,36 @@ export EDITOR=vim; _bin/newpost 'Post title'
2424

2525
### Contributing improvements or bug fixes
2626

27-
1. [Fork elixir-lang.github.com](https://github.com/elixir-lang/elixir-lang.github.com/fork).
27+
First of all, [fork this
28+
repository](https://github.com/elixir-lang/elixir-lang.github.com/fork).
2829

29-
2. Make your changes.
30+
To setup a development enviroment locally, you need to have Ruby installed; you
31+
can follow [this guide](https://www.ruby-lang.org/en/documentation/installation/) to install it.
32+
Once you have Ruby installed, `cd` into the forked project and run
3033

31-
3. Test it locally, you need to install the gems `jekyll` and `redcarpet`:
34+
```bash
35+
$ bundle install
36+
```
37+
38+
in order to download and install all the necessary dependencies and
3239

3340
```bash
34-
$ gem install jekyll redcarpet
35-
$ jekyll serve # check localhost:4000
41+
$ bundle exec jekyll serve
3642
```
3743

38-
4. Push to your forked repository.
44+
to run a development server (with live-reloading on) on port 4000.
45+
46+
Now you're ready to make your changes! Be sure to test the changes locally using
47+
the development server. Once you're done with your changes, push those changes
48+
to your fork and then submit a **pull request**.
3949

40-
5. Submit a pull-request for your changes.
50+
#### JavaScript processor
4151

42-
`jekyll` requires a javascript processor to be available too. Many OS provide such functionality but others do not. If you have an error related to ExecJS, you can work around it by either running `gem install therubyracer` or by ensuring node.js is available in your path.
52+
Jekyll (the static-site generator you installed before) requires a JavaScript
53+
processor to be available. Many operating systems provide such functionality but
54+
some don't. If you encounter errors related to "ExecJS", you can work around
55+
them by either installing the `therubyracer` gem (`$ gem install therubyracer`)
56+
or by ensuring [Node.js](http://nodejs.org) is in your `$PATH`.
4357

4458
### License
4559

0 commit comments

Comments
 (0)