You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This website was built using [Jekyll](https://jekyllrb.com/). So if you are familiar with this and it Jekyll installed, you can scroll past this simple development environment instructions we have below.
9
+
First things first. Make a local clone of this repo so you can work on it from your own computer.
10
10
11
-
**Setting up your development environment**
11
+
## Install, and Serve!
12
12
13
-
To do this, you are going to need a computer preferably running MacOSX or a linux distrubition. I (@torch2424) personally use [ElementaryOS](https://elementary.io/).
13
+
This website was built using [Jekyll](https://jekyllrb.com/). So if you are familiar with this and already have Jekyll installed, you can scroll past the instructions we have below.
14
14
15
-
Then you should follow this guide provided by [DigitalOcean](https://www.digitalocean.com/) on [Setting up Ruby On Rails with Rbenv on Ubuntu 14.04](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-14-04). You are going to need to install a version of ruby >= 2.0.0. I suggest the newest version, and I got it all set up with Ruby v2.2.3
15
+
**Setting up your development environment**
16
16
17
-
Once we have all of that installed we can focus on installing the required ruby gems...
17
+
To do this, you are going to need a computer capable of running Ruby - while Mac OSX or Linux tends to be easiest, plenty of people do Ruby development on Windows as well. If you're not on Mac OSX, you will likely need to install Ruby yourself.
18
18
19
19
**Install Gems and Serving the Website**
20
20
21
-
So the required gems for this website are [Bundler](http://bundler.io/) and [Jekyll](https://jekyllrb.com/). So, open up your favorite command line or terminal and enter the following instructions:
21
+
The required gems for this project are [Bundler](http://bundler.io/) and [Jekyll](https://jekyllrb.com/). Once you have Ruby installed, open your terminal, `cd` to the local repo directory, and run the following commands:
22
22
23
23
```
24
24
gem install jekyll
25
25
gem install bundle
26
26
```
27
27
28
-
This will install Bundler and Jekyll, if you have any errors, please ensure you have installed ruby correctly, or use Google to help you fix your development environment.
28
+
This will install Bundler and Jekyll. If you have any errors, check to be sure you have installed Ruby correctly.
29
29
30
-
Next we simply need to install the projects dependencies and serve:
30
+
Next, install the projects dependencies and serve:
31
31
32
32
```
33
33
bundle install
34
34
bundle exec jekyll serve
35
35
```
36
36
37
-
This should start serving the website on http://0.0.0.0:4000/for you to make changes and view them on your local machine!
37
+
This should start serving the website on http://0.0.0.0:4000/- simply make changes to the source code and can see your changes live at that URL!
38
38
39
-
##Contribute!
39
+
##Contribute!
40
40
41
-
We are open to all contributions by members of our organization, and we suggest all new members create their own [Members Page](http://www.codeandcoffeelb.org/members/) using the [instructions provided on our website](http://0.0.0.0:4000/members/#member_howto)
41
+
We are open to all contributions by members of our organization, and we encourage all new members to create their own [Members Page](http://www.codeandcoffeelb.org/members/) using the [instructions provided on our website](http://www.codeandcoffeelb.org/members/#member_howto)
42
42
43
-
**However we do have some rules and general guidelines we would like you to follow:**
43
+
**However, we do have some rules and general guidelines we would like you to follow:**
Merging the branch to master should not break anything in master. A branch should be fully testable and functional once finished - I should be able to deploy any given branch and have a functional site.
62
+
Merging the branch should not break anything. A branch should be fully testable and functional once finished - I should be able to deploy any given branch and have a functional site.
63
63
```
64
64
65
-
4.Pull requests may not be merged by the requester. Ever.
65
+
4.All pull requests should merge to development. Only an admin should merge to master.
66
66
67
-
```
68
-
Even me...
69
-
```
67
+
5. Pull requests may not be merged by the requester. Ever.
70
68
71
-
5. Once a pull request is merged, the branch should be removed.
69
+
6. Once a pull request is merged, the branch should be removed.
72
70
73
-
```
74
-
Just basic cleanup.
75
-
```
76
-
77
-
6. Pull Requests should use Github keywords so they automatically link to/close related issues.
71
+
7. Pull Requests should use Github keywords so they automatically link to/close related issues.
78
72
79
73
```
80
74
For reference: https://help.github.com/articles/closing-issues-via-commit-messages/
@@ -84,7 +78,3 @@ For more info on good github etiquette see below, these were nicely referenced b
84
78
85
79
[Git - Contributing to a Project](http://git-scm.com/book/ch5-2.html)
86
80
[Who-T - On Commit Messages](http://who-t.blogspot.com/2009/12/on-commit-messages.html)
87
-
88
-
##Licence
89
-
90
-
Tentatively is is [Creative Commons Attribution 3.0](https://creativecommons.org/licenses/by/3.0/us/)
0 commit comments