mirror of
https://github.com/golang/go
synced 2024-09-15 22:20:06 +00:00
doc/README: clarify instructions
- State that new markdown files belong in doc/next. - Give hints on correct markdown syntax. For #64169 Change-Id: Ied70e7ac443530c910eea2992ca6e303bbc10499 Reviewed-on: https://go-review.googlesource.com/c/go/+/558855 Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Jonathan Amsterdam <jba@google.com>
This commit is contained in:
parent
0b1b6c1589
commit
b079967467
|
@ -13,16 +13,24 @@ corresponding to standard library package paths, and headings for those package
|
||||||
paths will be generated automatically.
|
paths will be generated automatically.
|
||||||
|
|
||||||
Files in this repo's `api/next` directory must have corresponding files in
|
Files in this repo's `api/next` directory must have corresponding files in
|
||||||
`*stdlib/*minor`. The files should be in the subdirectory for the package with
|
`doc/next/*stdlib/*minor`.
|
||||||
the new API, and should be named after the issue number of the API proposal. For
|
The files should be in the subdirectory for the package with the new
|
||||||
example, an `api/next` file with the line
|
API, and should be named after the issue number of the API proposal.
|
||||||
|
For example, if the directory `6-stdlib/99-minor` is present,
|
||||||
|
then an `api/next` file with the line
|
||||||
|
|
||||||
pkg net/http, function F #12345
|
pkg net/http, function F #12345
|
||||||
|
|
||||||
should have a corresponding file named `net/http/12345.md`.
|
should have a corresponding file named `doc/next/6-stdlib/99-minor/net/http/12345.md`.
|
||||||
At a minimum, that file should contain either a full sentence or a TODO,
|
At a minimum, that file should contain either a full sentence or a TODO,
|
||||||
ideally referring to a person with the responsibility to complete the note.
|
ideally referring to a person with the responsibility to complete the note.
|
||||||
|
|
||||||
|
Use the following forms in your markdown:
|
||||||
|
|
||||||
|
[`http.Request`](/pkg/net/http#Request) # symbol documentation
|
||||||
|
[#12345](/issue/12345) # GitHub issues
|
||||||
|
[CL 6789](/cl/6789) # Gerrit changelists
|
||||||
|
|
||||||
## For the release team
|
## For the release team
|
||||||
|
|
||||||
At the start of a release development cycle, the contents of `next` should be deleted
|
At the start of a release development cycle, the contents of `next` should be deleted
|
||||||
|
|
Loading…
Reference in a new issue