Skip to content

Commit

Permalink
Adding contribution guideline.
Browse files Browse the repository at this point in the history
  • Loading branch information
danielniccoli committed Mar 31, 2013
1 parent d436b2f commit 7097f63
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions contributing.md
@@ -0,0 +1,26 @@
# Contributing to Cherokee Webserver

We love to see your interest in contributing to Cherokee Webserver!

This guide covers all you need to know to make this a fluid experience.

## Issues List

### Writing a new issue

So you found a bug, have a feature request, would like to see a functionality being enhanced or just have a simple question? Well -- that is just marvelous. Here is how you write a good ticket to make the process as easy as possible.

# Finding a suitable title

Give your issue a caption that is both, descriptive and precise. If your title makes it possible to grasp the meaning of your request, it is more likely to be read and successively worked on. But don't get to technical, that is the description for. Here are some example of good titles:

- #28
- #29
- #21
- #66
- #101

A rather bad title would be one of the following:

- #502 (Better: Random 504 gateway errors in reverse proxy mode.)
- #693 (Better: `cherokee-admin -u` throws: could not create socket.)

0 comments on commit 7097f63

Please sign in to comment.