forked from git/git
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Issue reporting guidelines
dscho edited this page Apr 13, 2015
·
15 revisions
- Search the existing open and closed issues. Maybe the bug was already reported?
- Include the output of git --version and the Windows version. In case the issue might depend on the server include its git version and OS version also.
- Describe your issue properly. If you spend 30 seconds throwing out a sloppy report, do expect that others will spend exactly the same amount on trying to resolve it.
- Include a Minimal, Complete, and Verifiable example using GitHub Markdown's
codeblock
delimiters. - If your issue stems from a particular repository include its URL. If the repository is proprietary try to create a public test repository showing the same issue.
- Be prepared to test fixes!
- Be polite. You are asking highly competent software developers for help, for free, so you might want to avoid treating them as if they were a commodity or at your free disposal.
- An example for an outstanding report can be found here. You may want to imitate the level of detail.
- For further inspiration, read reports that were resolved successfully, http://www.chiark.greenend.org.uk/~sgtatham/bugs.html, http://stackoverflow.com/questions/how-to-ask and http://whathaveyoutried.com/.
This wiki page has been retired. All it did was to point to Git for Windows' governance model.