lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

CONTRIBUTING: add a section on issues

Browse Source 
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.
This commit is contained in:
brian m. carlson 2019-05-30 14:56:37 +00:00
parent ff57c2e692
commit e6029b2247
No known key found for this signature in database
GPG Key ID: 2D0C9BC12F82B3A1
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.md
View File

@ -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