From 025c946292eaafc6a7a92b93f2ed6364da32c24e Mon Sep 17 00:00:00 2001 From: Aaron Turner Date: Mon, 8 Feb 2016 12:59:50 -0800 Subject: [PATCH 1/9] Started imporving the readme Added a last update, an image, as well as improved the header --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d436192..e568b43 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ -# Welcome to the repo for the codeandcoffeelb website +# Welcome to the official repo for the [CodeandCoffeeLB](http://codeandcoffeelb.github.io/) website -http://codeandcoffeelb.github.io/ +Last Update: February 8th, 2016 + +![alt text](http://i.imgur.com/4IpVh2u.jpg "Website Screenshot") From b7fff0c16ad30f7b26f498da541e756e3ee31061 Mon Sep 17 00:00:00 2001 From: Aaron Turner Date: Mon, 8 Feb 2016 13:24:39 -0800 Subject: [PATCH 2/9] Added Installation instrctions, as well as started the contribution section As the title states, all is looking good so far! --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e568b43..cf6f434 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,43 @@ -# Welcome to the official repo for the [CodeandCoffeeLB](http://codeandcoffeelb.github.io/) website +# Welcome to the official repo for the [CodeandCoffeeLB](http://codeandcoffeelb.github.io/) website! Last Update: February 8th, 2016 ![alt text](http://i.imgur.com/4IpVh2u.jpg "Website Screenshot") + +## Install, and Serve! + +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. + +**Setting up your development environment** + +To do this, you are going to need a computer preferably running MacOSX or a linux distrubition. I personally use [ElementaryOS](https://elementary.io/). + +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 + +Once we have all of that installed we can focus on installing the required ruby gems... + +**Install Gems and Serving the Website** + +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: + +``` +gem install jekyll +gem install bundle +``` + +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. + +Next we simply need to install the projects dependencies and serve: + +``` +bundle install +bundle exec jekyll serve +``` + +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! + +##Contribute! + +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) + +**However we do have some rules we would like you to follow:** From 9f760ef33eff59a6868514d6024a99a7128d937a Mon Sep 17 00:00:00 2001 From: Aaron Turner Date: Mon, 8 Feb 2016 13:41:34 -0800 Subject: [PATCH 3/9] Finished Up the basics of the Readme! Finished up the readme, I added some Installation instructions as well as some nice github etiquette --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cf6f434..6c91f52 100644 --- a/README.md +++ b/README.md @@ -40,4 +40,51 @@ This should start serving the website on http://0.0.0.0:4000/ for you to make ch 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) -**However we do have some rules we would like you to follow:** +**However we do have some rules and general guidelines we would like you to follow:** + +1. Everything must start with an issue... + +``` +Issues should have useful, concise titles and enough of a description to understand the scope of the issue. +``` + +2. Branches should link to individual issues, and be named using consistent syntax: + +``` +bug/#123-abbreviated-issue-title +feature/#123-abbreviated-issue-title +enhancement/#123-abbreviated-issue-title +``` + +3. A branch should represent an atomic change + +``` +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. +``` + +4. Pull requests may not be merged by the requester. Ever. + +``` +Even me... +``` + +5. Once a pull request is merged, the branch should be removed. + +``` +Just basic cleanup. +``` + +6. Pull Requests should use Github keywords so they automatically link to/close related issues. + +``` +For reference: https://help.github.com/articles/closing-issues-via-commit-messages/ +``` + +For more info on good github etiquette see below, these were nicely referenced by @karimamer : + +[Git - Contributing to a Project](http://git-scm.com/book/ch5-2.html) +[Who-T - On Commit Messages](http://who-t.blogspot.com/2009/12/on-commit-messages.html) + +##Licence + +To be determined! From eac3d8554604edf89dcd353a32e74e1fb56854d5 Mon Sep 17 00:00:00 2001 From: Aaron Turner Date: Mon, 8 Feb 2016 14:13:17 -0800 Subject: [PATCH 4/9] Updated the liscence as well as the screen shot Turned the website image into a nice little gif for us to view --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6c91f52..5cb461f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Last Update: February 8th, 2016 -![alt text](http://i.imgur.com/4IpVh2u.jpg "Website Screenshot") +![alt text](http://i.imgur.com/Mv34V2A.gif "Website Screenshot") ## Install, and Serve! @@ -10,7 +10,7 @@ This website was built using [Jekyll](https://jekyllrb.com/). So if you are fami **Setting up your development environment** -To do this, you are going to need a computer preferably running MacOSX or a linux distrubition. I personally use [ElementaryOS](https://elementary.io/). +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/). 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 @@ -87,4 +87,4 @@ For more info on good github etiquette see below, these were nicely referenced b ##Licence -To be determined! +Tentatively is is [Creative Commons Attribution 3.0](https://creativecommons.org/licenses/by/3.0/us/) From b4f21a0e2225d7c4cb4af43721cdf28256dd47b2 Mon Sep 17 00:00:00 2001 From: Roger Howard Date: Tue, 9 Feb 2016 00:09:42 -0800 Subject: [PATCH 5/9] Updated README * Removed license (needs further discussion) * Removed Rails installation guide * Added rule to merge to development only. * Misc. first pass edits --- README.md | 46 ++++++++++++++++++---------------------------- 1 file changed, 18 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 5cb461f..09367e0 100644 --- a/README.md +++ b/README.md @@ -4,43 +4,43 @@ Last Update: February 8th, 2016 ![alt text](http://i.imgur.com/Mv34V2A.gif "Website Screenshot") -## Install, and Serve! +## Clone this repo! -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. +First things first. Make a local clone of this repo so you can work on it from your own computer. -**Setting up your development environment** +## Install, and Serve! -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/). +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. -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 +**Setting up your development environment** -Once we have all of that installed we can focus on installing the required ruby gems... +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. **Install Gems and Serving the Website** -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: +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: ``` gem install jekyll gem install bundle ``` -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. +This will install Bundler and Jekyll. If you have any errors, check to be sure you have installed Ruby correctly. -Next we simply need to install the projects dependencies and serve: +Next, install the projects dependencies and serve: ``` bundle install bundle exec jekyll serve ``` -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! +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! -##Contribute! +## Contribute! -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) +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) -**However we do have some rules and general guidelines we would like you to follow:** +**However, we do have some rules and general guidelines we would like you to follow:** 1. Everything must start with an issue... @@ -59,22 +59,16 @@ enhancement/#123-abbreviated-issue-title 3. A branch should represent an atomic change ``` -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. +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. ``` -4. Pull requests may not be merged by the requester. Ever. +4. All pull requests should merge to development. Only an admin should merge to master. -``` -Even me... -``` +5. Pull requests may not be merged by the requester. Ever. -5. Once a pull request is merged, the branch should be removed. +6. Once a pull request is merged, the branch should be removed. -``` -Just basic cleanup. -``` - -6. Pull Requests should use Github keywords so they automatically link to/close related issues. +7. Pull Requests should use Github keywords so they automatically link to/close related issues. ``` 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 [Git - Contributing to a Project](http://git-scm.com/book/ch5-2.html) [Who-T - On Commit Messages](http://who-t.blogspot.com/2009/12/on-commit-messages.html) - -##Licence - -Tentatively is is [Creative Commons Attribution 3.0](https://creativecommons.org/licenses/by/3.0/us/) From c693a61dfb128e7f80f1dc86837a083635983f37 Mon Sep 17 00:00:00 2001 From: Roger Howard Date: Wed, 10 Feb 2016 10:34:56 -0800 Subject: [PATCH 6/9] Changed code blocks to block quotes --- README.md | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 09367e0..6c59e1c 100644 --- a/README.md +++ b/README.md @@ -44,23 +44,17 @@ We are open to all contributions by members of our organization, and we encourag 1. Everything must start with an issue... -``` -Issues should have useful, concise titles and enough of a description to understand the scope of the issue. -``` +> Issues should have useful, concise titles and enough of a description to understand the scope of the issue. 2. Branches should link to individual issues, and be named using consistent syntax: -``` -bug/#123-abbreviated-issue-title -feature/#123-abbreviated-issue-title -enhancement/#123-abbreviated-issue-title -``` +> bug/#123-abbreviated-issue-title +> feature/#123-abbreviated-issue-title +> enhancement/#123-abbreviated-issue-title 3. A branch should represent an atomic change -``` -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. -``` +> 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. 4. All pull requests should merge to development. Only an admin should merge to master. @@ -70,9 +64,7 @@ Merging the branch should not break anything. A branch should be fully testable 7. Pull Requests should use Github keywords so they automatically link to/close related issues. -``` -For reference: https://help.github.com/articles/closing-issues-via-commit-messages/ -``` +> For reference: https://help.github.com/articles/closing-issues-via-commit-messages/ For more info on good github etiquette see below, these were nicely referenced by @karimamer : From a97b808a90bf251230fb62b25149fa434d5a6714 Mon Sep 17 00:00:00 2001 From: Roger Howard Date: Wed, 10 Feb 2016 10:37:08 -0800 Subject: [PATCH 7/9] Testing nested list --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6c59e1c..8d60331 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,13 @@ We are open to all contributions by members of our organization, and we encourag 1. Everything must start with an issue... -> Issues should have useful, concise titles and enough of a description to understand the scope of the issue. + * Issues should have useful, concise titles and enough of a description to understand the scope of the issue. 2. Branches should link to individual issues, and be named using consistent syntax: -> bug/#123-abbreviated-issue-title -> feature/#123-abbreviated-issue-title -> enhancement/#123-abbreviated-issue-title + * > bug/#123-abbreviated-issue-title + > feature/#123-abbreviated-issue-title + > enhancement/#123-abbreviated-issue-title 3. A branch should represent an atomic change From f19ead8af82144e3ef168162713ca754214f3f34 Mon Sep 17 00:00:00 2001 From: Roger Howard Date: Wed, 10 Feb 2016 10:38:34 -0800 Subject: [PATCH 8/9] Reformatting contribution rules --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8d60331..805f8c1 100644 --- a/README.md +++ b/README.md @@ -46,15 +46,15 @@ We are open to all contributions by members of our organization, and we encourag * Issues should have useful, concise titles and enough of a description to understand the scope of the issue. -2. Branches should link to individual issues, and be named using consistent syntax: +2. Branches should link to individual issues, and be named using consistent syntax consisting of "issue type", "issue number", and an descriptive title (using hyphens for spaces, and all lower case). Examples: - * > bug/#123-abbreviated-issue-title - > feature/#123-abbreviated-issue-title - > enhancement/#123-abbreviated-issue-title + * bug/#123-abbreviated-issue-title + * feature/#123-abbreviated-issue-title + * enhancement/#123-abbreviated-issue-title 3. A branch should represent an atomic change -> 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. + * 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. 4. All pull requests should merge to development. Only an admin should merge to master. @@ -64,7 +64,7 @@ We are open to all contributions by members of our organization, and we encourag 7. Pull Requests should use Github keywords so they automatically link to/close related issues. -> For reference: https://help.github.com/articles/closing-issues-via-commit-messages/ + * For reference: https://help.github.com/articles/closing-issues-via-commit-messages/ For more info on good github etiquette see below, these were nicely referenced by @karimamer : From 63ad42502a1de766ec75c3f4e1b847ae5dc3450d Mon Sep 17 00:00:00 2001 From: Roger Howard Date: Wed, 10 Feb 2016 10:39:58 -0800 Subject: [PATCH 9/9] More reformatting of contribution rules --- README.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 805f8c1..350ae74 100644 --- a/README.md +++ b/README.md @@ -43,17 +43,14 @@ We are open to all contributions by members of our organization, and we encourag **However, we do have some rules and general guidelines we would like you to follow:** 1. Everything must start with an issue... - * Issues should have useful, concise titles and enough of a description to understand the scope of the issue. 2. Branches should link to individual issues, and be named using consistent syntax consisting of "issue type", "issue number", and an descriptive title (using hyphens for spaces, and all lower case). Examples: - * bug/#123-abbreviated-issue-title * feature/#123-abbreviated-issue-title * enhancement/#123-abbreviated-issue-title 3. A branch should represent an atomic change - * 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. 4. All pull requests should merge to development. Only an admin should merge to master. @@ -63,10 +60,8 @@ We are open to all contributions by members of our organization, and we encourag 6. Once a pull request is merged, the branch should be removed. 7. Pull Requests should use Github keywords so they automatically link to/close related issues. - * For reference: https://help.github.com/articles/closing-issues-via-commit-messages/ -For more info on good github etiquette see below, these were nicely referenced by @karimamer : - -[Git - Contributing to a Project](http://git-scm.com/book/ch5-2.html) -[Who-T - On Commit Messages](http://who-t.blogspot.com/2009/12/on-commit-messages.html) +8. Always follow good Github etiquette. Several helpful reads on the topic: + * [Git - Contributing to a Project](http://git-scm.com/book/ch5-2.html) + * [Who-T - On Commit Messages](http://who-t.blogspot.com/2009/12/on-commit-messages.html)