Index: llvm/docs/DeveloperPolicy.rst =================================================================== --- llvm/docs/DeveloperPolicy.rst +++ llvm/docs/DeveloperPolicy.rst @@ -201,6 +201,11 @@ entire failing program into ``llvm/test`` as this creates a *time-to-test* burden on all developers. Please keep them short. +* Avoid adding links to resources that are not available to the entire + community, such as links to private bug trackers, internal corporate + documentation, etc. Instead, add sufficient comments to the test to provide + the context behind such links. + Note that llvm/test and clang/test are designed for regression and small feature tests only. More extensive test cases (e.g., entire applications, benchmarks, etc) should be added to the ``llvm-test`` test suite. The llvm-test suite is @@ -256,6 +261,11 @@ the change (more invasive changes require more testing). A reasonable subset might be something like "``llvm-test/MultiSource/Benchmarks``". +#. Ensure that links in source code and test files point to publicly available + resources and are used primarily to add additional information rather than + to supply critical context. The surrounding comments should be sufficient + to provide the context behind such links. + Additionally, the committer is responsible for addressing any problems found in the future that the change is responsible for. For example: @@ -336,8 +346,6 @@ code snippets and gory details should be left to bug comments, web review or the mailing list. -* If the patch fixes a bug in GitHub Issues, please include the PR# in the message. - * Text formatting and spelling should follow the same rules as documentation and in-code comments, ex. capitalization, full stop, etc. @@ -346,8 +354,13 @@ related commit. This could be as simple as "Revert commit NNNN because it caused PR#". -* If the patch has been reviewed, add a link to its review page, as shown - `here `_. +* It is acceptable to add metadata to the commit message to automate processes, + including for downstream consumers. If the patch fixes a bug in GitHub Issues, + we encourage adding a reference to the issue being closed, as described + `here `_. + Other kinds of metadata are also acceptable, including links to resources + that are not available to the entire community. However, such links should + not be used in place of making the commit message self-explanatory. For minor violations of these recommendations, the community normally favors reminding the contributor of this policy over reverting. Minor corrections and