Skip to content

Commit

Permalink
Add CONTRIBUTING guide
Browse files Browse the repository at this point in the history
  • Loading branch information
petros committed Nov 21, 2013
1 parent 4e72e48 commit 3d13aa9
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#### We love pull requests. Here's a quick guide

1. If you are a member of thessaloniki/thessrb-members team you can skip
2.
2. Fork the repository (want to be a member and not have to fork? [Check
how]())
3. Create a topic branch, do some work, push it, and create a pull
request.

#### Things we like

* Nice title and a complete description of what and why in the pull
request body.
* Check what is already in the repository to see how you should format
things.
* If you are contributing written text, we like the Markdown format.

#### Things to avoid

* Spaces or underscores in filenames (we prefer dashes to separate
words, but single word filenames are better if possible)
* Don't commit large binary files and if you have to commit smaller
ones, make sure they are not going to be updated often. For all other
cases, it's better to host the file somewhere else and provide a link to
it (for example presentations etc.)

0 comments on commit 3d13aa9

Please sign in to comment.