1
0
mirror of https://github.com/golang/go synced 2024-09-30 16:18:35 -06:00

gopls: add status and roadmap to the main readme.

Change-Id: I5794d1afd0bcddbe3c1a4e2546133df4ce044e2f
Reviewed-on: https://go-review.googlesource.com/c/tools/+/211577
Reviewed-by: Rebecca Stambler <rstambler@golang.org>
This commit is contained in:
Ian Cottrell 2019-12-16 16:41:04 -05:00
parent 42268a1f04
commit bbbf87ae26

View File

@ -2,11 +2,41 @@
gopls (pronounced: "go please") is the official [language server] for the Go language.
It is currently in **alpha**, so it is **not stable**. You can see more information about the status of gopls and its supported features [here](doc/status.md).
## Status
It is currently in **alpha**, so it is **not stable**.
You can see more information about the status of gopls and its supported features [here](doc/status.md).
## Roadmap
The current goal is a fully stable build with the existing feature set, aiming
for the first half of 2020, with release candidates earlier in the year.
This will be the first build that we recommend people use, and will be tagged as the 1.0 version.
You can see the set of things being worked on in the [1.0 milestone], in general
we are focused on stability, specifically, making sure we have a reliable service that produces an experience in module mode that is not a retrograde step from the old tools in GOPATH mode.
There is also considerable effort being put into testing in order to make sure that we both have a stable service and also that we do not regress after launch.
While we may continue to accept contributions for new features, they may be turned off behind a configuration flag if they are not yet stable. See the [gopls unplanned] milestone for deprioritized features.
This is just a milestone for gopls itself. We work with editor integrators to make sure they can use the latest builds of gopls, and will help them use the 1.0 version as soon as it is ready, but that does not imply anything about the stability, supported features or version of the plugins.
## Using
In general you should not need to know anything about gopls, it should be integrated into your editor for you.
See the [installing](doc/user.md) section of the user guide if you need to install or update gopls by hand.
To install for your specific editor you can follow the following instructions
* [VSCode](vscode.md)
* [Vim / Neovim](vim.md)
* [Emacs](emacs.md)
* [Acme](acme.md)
* [Sublime Text](subl.md)
* [Atom](atom.md)
See the [user guide](doc/user.md) for more information, including the how to install gopls by hand if you need.
## Issues
@ -37,3 +67,5 @@ If you want to know more about it, have an unusual use case, or want to contribu
[slack channel]: https://gophers.slack.com/messages/CJZH85XCZ
[@stamblerre]: https://github.com/stamblerre "Rebecca Stambler"
[@ianthehat]: https://github.com/ianthehat "Ian Cottrell"
[1.0 milestone]: https://github.com/golang/go/milestone/112
[gopls unplanned]: https://github.com/golang/go/milestone/124