From 1eb50caf713ea3d7337e395ac024f2d8afeb6a60 Mon Sep 17 00:00:00 2001 From: Chris Sommers Date: Wed, 20 Apr 2022 16:12:42 -0700 Subject: [PATCH] Add github rule warning against directly committing new artiofacts w/o a PR. --- doc-github-rules.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/doc-github-rules.md b/doc-github-rules.md index e85d74064..8cc8ce72f 100644 --- a/doc-github-rules.md +++ b/doc-github-rules.md @@ -83,8 +83,13 @@ Once a PR has received sufficient review and concerns are satisfied, a designate Contributors with write access permission or higher have rights to directly edit documents and push changes. This practice should be used very sparingly, and only in the draft stages of documents, or to make trivial changes in documents already in use. > [!WARNING] -> Direct edits (without proper review phases) to "released" documents short-circuits the normal community process and can result in breaking changes and significant disruption, resulting in potential impact to downstream consumers. +> Direct edits (without proper PR and review) to "released" artifacts short-circuits the normal community process and can result in breaking changes and significant disruption, resulting in potential impact to downstream consumers. +## Avoid Directly Committing New Artifacts +As a corrollary to the hazards of directly editing documents, contributors with write access permission or higher have rights to directly commit new documents. This should be avoided. Skipping the normal PR and review process prevents reviewers from making inline comments against "Files Changed" etc. Only summary comments of the commit itself are possible, which is less useful. + +> [!WARNING] +> Direct commits (without proper PR and review) of new artifacts short-circuits the normal community process and should be avoided. ## Use checklists for large issues or PRs