Sample project readme

README.md

Contributing

Setup

Clone the repo and setup Apache / Nginx:

$ cd ~/Sites
$ git clone git@github.com:project-github-account/Project.git

Setup Apache / Nginx

• http://httpd.apache.org/docs/current/vhosts/examples.html
• https://www.digitalocean.com/community/articles/how-to-set-up-nginx-virtual-hosts-server-blocks-on-ubuntu-12-04-lts--3
• Point document root to /Project/public

Developing

• Create feature branches, issue pull requests to merge them.
• Rebase master into your feature branches often.

Create feature branch

$ git pull --rebase origin master
$ git checkout -b my-new-feature
...work work work

Issue pull request

$ git co master
$ git pull --rebase origin master   (update master with latest)
$ git checkout my-new-feature
$ git rebase master                 (rebase master onto your feature branch)
(resolve conflicts if any)

$ git push origin my-new-feature
(create a pull request for your branch)

Proper pull requests

• https://help.github.com/articles/using-pull-requests