Skip to content

Commit

Permalink
Changed Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
flov committed Feb 7, 2014
1 parent b17962e commit 8e750f5
Showing 1 changed file with 55 additions and 14 deletions.
69 changes: 55 additions & 14 deletions README.md
Expand Up @@ -3,22 +3,63 @@ Hitchlog

[![Build Status](https://travis-ci.org/flov/Hitchlog.png?branch=master)](https://travis-ci.org/flov/Hitchlog)

Hitchhiking enables you to meet heaps of different
people, to have an eventful journey, to learn about your fellow human beings by
Hitchhiking enables the traveller, to have an eventful journey, to learn
more about our fellow human beings and many more things.

direct interaction and many more things. On top of it it's free and
heaps of fun (**yay**)
# Vision

For a person who has never hitchhiked, hitchhiking might seem weird,
dangerous or short-minded. The
Hitchlog aims at changing this image by gathering data of actual hitchhiking
experiences which paints an authentic, real
picture about what Hitchhiking is actually like.
The hitchlog is a **social network for hitchhikers** which makes
information on previous hitchhiking experiences readily available.
To a person who has never hitchhiked before, hitchhiking might seem dangerous or
short-minded. The Hitchlog aims at changing this image by gathering data
of actual hitchhiking experiences which paints a real picture about what
Hitchhiking is actually like.

Contribution
------------
# Contributing to Hitchlog

Any contribution is highly appreciated!
[Flov](https://github.com/flov/Hitchlog/tree/crisp) can't do all the
work at the moment because most of the time he is traveling and he
doesn't have too much time to sit in front of a screen ;)

## Reporting Bugs

Add an [issue on GitHub](https://github.com/flov/Hitchlog/issues) with a
reproduction of the bug including workflows or screenshots. If
possible, submit a Pull Request with a failing test. If you'd rather
take matters into your own hands, fix the bug yourself (jump down to the
"Contributing (Step-by-step)" section).

## Contributing (Step-by-step)

1. Clone the Repo:

git clone git://github.com/discourse/discourse.git

2. Create a new Branch:

cd discourse
git checkout -b new_discourse_branch

3. Code
* Adhere to common conventions you see in the existing code
* Include tests, and ensure they pass

4. Commit and push to your remote

* add files to git via `git add files...`

git commit -m
git push mine new_discourse_branch


4. Issue a Pull Request

In order to make a pull request,
* Navigate to the Hitchlog repository you just pushed to (e.g. https://github.com/your-user-name/discourse)
* Click "Pull Request".
* Write your branch name in the branch field (this is filled with "master" by default)
* Click "Update Commit Range".
* Ensure the changesets you introduced are included in the "Commits" tab.
* Ensure that the "Files Changed" incorporate all of your changes.
* Fill in some details about your potential patch including a meaningful title.
* Click "Send pull request".

Thanks for that :)

0 comments on commit 8e750f5

Please sign in to comment.