| # Documentation for contributors |
| |
| Contributions are welcome, but since development is so active, we request that you file an issue and claim it before starting to work on something. Otherwise, it is likely that we might already be working on a fix for your issue. |
| |
| ## Finding issues |
| |
| All `gopls` issues are labeled as such (see the [`gopls` label][issue-gopls]). Issues that are suitable for contributors are additionally tagged with the [`help-wanted` label][issue-wanted]. |
| |
| Before you begin working on an issue, please leave a comment that you are claiming it. |
| |
| ## Getting started |
| |
| <!--- TODO: getting started |
| Provide information to get contributors up and running here |
| ---> |
| |
| ## Testing |
| |
| To run tests for just `gopls/`, run, |
| |
| ``` |
| cd /path/to/tools/gopls |
| go test ./... |
| ``` |
| |
| But, much of the gopls work involves `internal/lsp` too, so you might want to |
| run both: |
| |
| ``` |
| cd /path/to/tools |
| cd gopls && go test ./... |
| cd .. |
| go test ./internal/lsp/... |
| ``` |
| |
| ## Debugging |
| |
| <!--- TODO: debugging |
| actual debugging steps |
| viewing telemetry |
| ---> |
| |
| [issue-gopls]: https://github.com/golang/go/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3Agopls "gopls issues" |
| [issue-wanted]: https://github.com/golang/go/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3Agopls+label%3A"help+wanted" "help wanted" |
