From e6029b22478d8d00271bb002ef3d5960f53e9e28 Mon Sep 17 00:00:00 2001 From: "brian m. carlson" Date: Thu, 30 May 2019 14:56:37 +0000 Subject: [PATCH] CONTRIBUTING: add a section on issues Add a section on issues that addresses a few common problems we see when people report an issue. Encourage users to provide helpful debugging information like the output of "git lfs env" and GIT_TRACE output, and to use the troubleshooting section of the wiki to help pin down any problems. Point out that opening a new issue is preferable to commenting on a closed issue. Mention that problems with GitHub are best addressed directly with GitHub; these are things we aren't likely to be able address here, and folks reporting them to GitHub are likely to get a better response and quicker action. --- CONTRIBUTING.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 671eccd2..f62f5545 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,6 +74,27 @@ them as separate pull requests. * Explain the rationale for your change in the pull request. You can often use part of a good commit message as a starting point. +## Issues + +If you think you've found a bug or have an issue, we'd love to hear about it! +Here are some tips for getting your question answered as quickly as possible: + +* It's helpful if your issue includes the output of `git lfs env`, plus any + relevant information about platform or configuration (e.g., container or CI + usage, Cygwin, WSL, or non-Basic authentication). +* Take a look at the [troubleshooting](https://github.com/git-lfs/git-lfs/wiki/Troubleshooting) + page on the wiki. We update it from time to time with information on how to + track down problems. If it seems relevant, include any information you've + learned by following those steps. +* If you're having problems with GitHub's server-side LFS support, it's best to + reach out to [GitHub's support team](https://github.com/contact) to get help. + We aren't able to address GitHub-specific issues in this project, but the + GitHub support team will do their best to help you out. +* If you see an old issue that's closed as fixed, but you're still experiencing + the problem on your system, please open a new issue. The problem you're seeing + is likely different, at least in the way it works internally, and we can help + best when we have a new issue with all the information. + ## Building ### Prerequisites