From 7097f6388a71988f92de99e1a67370f018b8ee5a Mon Sep 17 00:00:00 2001 From: Birk Borkason Date: Sun, 31 Mar 2013 17:58:42 +0200 Subject: [PATCH] Adding contribution guideline. --- contributing.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 contributing.md diff --git a/contributing.md b/contributing.md new file mode 100644 index 000000000..a6ea690c9 --- /dev/null +++ b/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.)