[all-commits] [llvm/llvm-project] 677326: Specify the developer policy around links to exter...

[Aaron Ballman via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 677326999f270395ecaec026178fe7ed148a0068
      https://github.com/llvm/llvm-project/commit/677326999f270395ecaec026178fe7ed148a0068
  Author: Aaron Ballman <aaron at aaronballman.com>
  Date:   2023-08-15 (Tue, 15 Aug 2023)

  Changed paths:
    M llvm/docs/DeveloperPolicy.rst

  Log Message:
  -----------
  Specify the developer policy around links to external resources

This specifies the developer policy on adding links in source & test
files and commit messages, related to discussion at:
https://discourse.llvm.org/t/code-review-reminder-about-links-in-code-commit-messages/71847

The intent is to discourage adding links to resources that are not
available to the community as a whole (dead links, links to internal
documentation, links to internal bug trackers, etc) from source and
test files, while still allowing such links to appear in other contexts
as needed. It suggests to instead add sufficient context in the
surrounding comments to make such links unnecessary.

It also clarifies that these links can appear in commit messages as
metadata (similar to how we already have Differential Revision and
Fixes metadata with links).

Differential Revision: https://reviews.llvm.org/D155081