Skip to content

Commit

Permalink
doc: add author-ready label ref to onboarding doc
Browse files Browse the repository at this point in the history
The "Labels" section of doc/guides/onboarding-extras.md was missing a
reference to the `author-ready` label. This commit adds a description
similar to the definition found in doc/guides/collaborator-guide.md
with the goal of making it easier for new contributors to find labels
info all in one place.

PR-URL: #34381
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
  • Loading branch information
ruyadorno authored and MylesBorins committed Jul 22, 2020
1 parent 7603c7e commit bfef588
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion doc/guides/onboarding-extras.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,19 @@ request.
* `tsc-agenda` - Open issues and pull requests with this label will be added to
the Technical Steering Committee meeting agenda

--
---

* `author-ready` - A pull request is _author ready_ when:
* There is a CI run in progress or completed.
* There is at least one Collaborator approval (or two TSC approvals
for semver-major PRs).
* There are no outstanding review comments.

Please always add the `author ready` label to the pull request in that case.
Please always remove it again as soon as the conditions are not met anymore,
such as if CI run fails or a new outstanding review comment is posted.

---

* `semver-{minor,major}`
* be conservative – that is, if a change has the remote *chance* of breaking
Expand Down

0 comments on commit bfef588

Please sign in to comment.