Versions Compared

Version Old Version 23 New Version Current
Changes made by

Nick Vigilante (Deactivated)

James Linder

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • GitHub issue numbers: #58420

  • GitHub issues in other repositories: cockroachdb/docs#14958

  • GitHub URLs: https://github.com/cockroachdb/cockroach/issues/78601

  • Jira issue keys: DOC-2356

  • Jira URLs: https://cockroachlabs.atlassian.net/browse/DOC-5432

Supported Keywords and Key Phrases

The standard GitHub keywords for linking and closing issues are supported. 

  • Only one issue should be included per keyword. If multiple issues are included for a keyword, GitHub will only close the first issue in the list.

  • Only referenced GitHub issues are closed.

...

  • Supported phrases:

    • Informs

    • See also

    • Part of

  • A list of issues may be included for each phrase.

  • These issues are not linked or closed.

...

Code Block
Fixes: #64276
Closed cockroachdb/pebble#482
Resolved: https://github.com/cockroachdb/cockroach/issues/77376
Informs: #33316
See also #62585, DOC-4023
Part of https://cockroachlabs.atlassian.net/browse/CRDB-13558

Epic Ref (Jira Epic References)

To include an epic reference, use Epic: <jira-epic-key> or Epic: <url>

  • It must be on a line by itself with no whitespace before it.

Examples:

Code Block
# key-only reference:
Epic: CRDB-8035

# URL reference:
Epic: https://cockroachlabs.atlassian.net/browse/CRDB-8035

# if no Issue or Epic reference
Epic: none

...

This check contains logs that will print helpful information about whether the PR body and/or the commit messages are missing an issue or epic reference. The check is not required, but that may change in the future with advanced warning.

What happens if the linter fails?

In the case where this linter fails, you may receive an email about it from GitHub. If you wish to disable these emails, follow these steps:

  1. Log in to GitHub and open up your notification settings.

  2. Under System > Actions, disable the Email notifications.

I don't work for Cockroach Labs. How do I resolve this?

If you don't work for Cockroach labs, the person reviewing the PR will take care of resolving this for you.

How to help external contributors add issue and epic references

We will occasionally When we receive PRs from external contributors. Unfortunately, they likely won't know which issue or epic is associated with the change they are making. It is the reviewer’s reviewer's responsibility to identify the issue / epic associated with the PR.

Once you've identified the issue / epic to reference(s), you can ask them to either update the PR body with the reference or amend their commit(s) messagewith the reference(s) or the PR body with the appropriate references. If you'd like, you may let them know you made the edits.