Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Fixed spelling

  • Loading branch information...
commit c36226b0664c66fee0b3b12031ee7ed820d140a5 1 parent 9837f5f
Daniel Niccoli Borkason authored
Showing with 4 additions and 4 deletions.
  1. +4 −4 contributing.md
8 contributing.md
View
@@ -21,20 +21,20 @@ So you found a bug, have a feature request, would like to see a functionality be
Give your issue a caption that is both, **descriptive and precise**. If your title makes it possible to grasp the meaning of your request, you are helping the developers to easily label the issue and pick those out who are important.
-Here are some good examples:
+**Here are some good examples:**
- *“Worker using 100% cpu with big files.”*
- *“Information Source ignoring Spawning Timeout.”*
- *“Content-Encoding header not implemented for static files already compressed.”*
-And here are some not so good:
+**And here are some not so good:**
- *“504 Gateway error”*
This is too generic, how about: “*Random 504 gateway errors in reverse proxy mode.*”?
- *“error message running cherokee-admin”*
An itsy-bitsy bit better, but can still be improved: “*`cherokee-admin -u` throws: could not create socket.*
-But **don't get to technical** over the fact that we prefer precise titles. Remember, you already know the defect behind that issue, and even the problematic line of code, the developer might just not and needs to read the description to understand what exactly is the problem. Such information are appropriate for the descripton, not for the title.
+But **don't get too technical** over the fact that we prefer precise titles. Remember, you already know the defect behind that issue, and even the problematic line of code, the developer might just not and needs to read the description to understand what exactly is the problem. Such information are appropriate for the descripton, not for the title.
-A bad example:
+**A bad example:**
- *“fdpoll-epoll.c:113: epoll_ctl(6, EPOLL_CTL_ADD, 3): 'File exists'”*
At the same time the opener provided a perfect line title just in the description.
Please sign in to comment.
Something went wrong with that request. Please try again.