github.com/bhcleek/gometalinter@v2.0.6-0.20180316043659-b25b44d18fb6+incompatible/CONTRIBUTING.md (about)

     1  ### Please only report errors with gometalinter itself
     2  
     3  gometalinter relies on underlying linters to detect issues in source code.
     4  If your issue seems to be related to an underlying linter, please report an
     5  issue against that linter rather than gometalinter. For a full list of linters
     6  and their repositories please see the [README](README.md).
     7  
     8  ### Do you want to upgrade a vendored linter?
     9  
    10  Please send a PR. We use [GVT](https://github.com/FiloSottile/gvt). It should be as simple as:
    11  
    12  ```
    13  go get github.com/FiloSottile/gvt
    14  cd _linters
    15  gvt update <linter>
    16  git add <paths>
    17  ```
    18  
    19  ### Before you report an issue
    20  
    21  Sometimes gometalinter will not report issues that you think it should. There
    22  are three things to try in that case:
    23  
    24  #### 1. Update to the latest build of gometalinter and all linters
    25  
    26      go get -u github.com/alecthomas/gometalinter
    27      gometalinter --install
    28  
    29  If you're lucky, this will fix the problem.
    30  
    31  #### 2. Analyse the debug output
    32  
    33  If that doesn't help, the problem may be elsewhere (in no particular order):
    34  
    35  1. Upstream linter has changed its output or semantics.
    36  2. gometalinter is not invoking the tool correctly.
    37  3. gometalinter regular expression matches are not correct for a linter.
    38  4. Linter is exceeding the deadline.
    39  
    40  To find out what's going on run in debug mode:
    41  
    42      gometalinter --debug
    43  
    44  This will show all output from the linters and should indicate why it is
    45  failing.
    46  
    47  #### 3. Run linters manually
    48  
    49  The output of `gometalinter --debug` should show the exact commands gometalinter
    50  is running. Run these commands from the command line to determine if the linter
    51  or gometaliner is at fault.
    52  
    53  #### 4. Report an issue.
    54  
    55  Failing all else, if the problem looks like a bug please file an issue and
    56  include the output of `gometalinter --debug`