Skip to content

Commit ee0bf1d

Browse files
committed
doc/README.md: mention adding the proposal issue
Inform users that every accepted proposal should be mentioned in the release notes to avoid generating a TODO. Also, clarify instructions for the release team. For #64169. Change-Id: I03921739af31fc93f4b5808b2c7c98e28ad3da11 Reviewed-on: https://go-review.googlesource.com/c/go/+/584615 Reviewed-by: Dmitri Shuralyov <[email protected]> Reviewed-by: Dmitri Shuralyov <[email protected]> LUCI-TryBot-Result: Go LUCI <[email protected]>
1 parent 722d594 commit ee0bf1d

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

doc/README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,16 @@ should have a corresponding file named `doc/next/6-stdlib/99-minor/net/http/1234
2727
At a minimum, that file should contain either a full sentence or a TODO,
2828
ideally referring to a person with the responsibility to complete the note.
2929

30+
If your CL addresses an accepted proposal, mention the proposal issue number in
31+
your release note in the form `/issue/NUMBER`. A link to the issue in the text
32+
will have this form (see below). If you don't want to mention the issue in the
33+
text, add it as a comment:
34+
```
35+
<!-- go.dev/issue/12345 -->
36+
```
37+
If an accepted proposal is mentioned in a CL but not in the release notes, it will be
38+
flagged as a TODO by the automated tooling. That is true even for proposals that add API.
39+
3040
Use the following forms in your markdown:
3141

3242
[http.Request] # symbol documentation; auto-linked as in Go doc strings
@@ -35,14 +45,20 @@ Use the following forms in your markdown:
3545

3646
## For the release team
3747

38-
At the start of a release development cycle, the contents of `next` should be deleted
39-
and replaced with those of `initial`. From the repo root:
48+
The `relnote` tool, at `golang.org/x/build/cmd/relnote`, operates on the files
49+
in `doc/next`.
50+
51+
As a release cycle nears completion, run `relnote todo` to get a list of
52+
unfinished release note work.
53+
54+
To prepare the release notes for a release, run `relnote generate`.
55+
That will merge the `.md` files in `next` into a single file.
56+
57+
To begin the next release development cycle, delete the contents of `next`
58+
and replace them with those of `initial`. From the repo root:
4059

4160
> cd doc
4261
> rm -r next/*
4362
> cp -r initial/* next
4463

4564
Then edit `next/1-intro.md` to refer to the next version.
46-
47-
To prepare the release notes for a release, run `golang.org/x/build/cmd/relnote generate`.
48-
That will merge the `.md` files in `next` into a single file.

0 commit comments

Comments
 (0)