Add section for search

2-4601
2016-03-04 02:57:46 +02:00
parent 3ab5407a6f
commit 13058c8da5

@@ -40,6 +40,12 @@ First, thank you many times over for taking the time to file a bug. For the repo
> https://gist.github.com/anonymous/j166l3m3554635
# Characteristics
### Search, search, search
Before submitting a new issue please search if someone has already opened an issue about the same topic. Don't forget to search for both open and closed issues as GitHub only searches for open issues by default.
If the issue you are searching for is very general and the search keywords are very common it's possible to get too many results. For example if you would like to find an issue about searching strings within your conversations, you could try a search with these keywords `is:issue message search`. That returns close to a hundred issues which is way too many. To narrow down your search you could refine it by looking only into the titles like this `is:issue in:title message search`. For more information about search parameters have a look at GitHub's [Searching issues](https://help.github.com/articles/searching-issues/) guide. One thing to be noted though is that GitHub's search is far from perfect. Even if you know all the parameters it has some big draw backs, e.g. it does not recognize that `message` and `messages` are basically the same thing.
### Come up with a concise and descriptive title
A good title sums the issue in a few words and makes it easily searchable. There's no need to use tags such as _"[Feature]"_ in the titles. Speaking of search: did you try searching duplicate issues by using your title as search keywords?