From cee4c7eaf0ddfc2e8226deb9eee727b4e843afb8 Mon Sep 17 00:00:00 2001 From: Bryan Wilder Field Lozano Date: Thu, 19 Sep 2024 17:08:18 -0700 Subject: [PATCH] [skip ci] #12912: Update CONTRIBUTING.md (#12913) --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 50e9980832e..a3b71fda5b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,6 +26,7 @@ Table of Contents - [File structure and formats](#file-structure-and-formats) - [CI/CD Principles](#cicd-principles) - [Using CI/CD for development](#using-cicd-for-development) + - [Skipping CI/CD for documentation updates](#skipping-cicd-for-documentation-updates) - [Documentation](#documentation) - [Git rules and guidelines](#git-rules-and-guidelines) - [Code reviews](#code-reviews) @@ -505,6 +506,13 @@ cat generated/watcher/watcher.log # See k_ids field for each core in the last d is still the most important factor in ensuring PRs are merged successfully and without CI failure. +### Skipping CI/CD for documentation updates +- CI/CD can be skipped for *documentation only* updates that incur no functional change. +- Upon submitting a PR and getting the necessary appovals: + - Click Squash and Merge + - Before confirming, edit the top level commit message by prepending the token `[skip ci]` + - Example: `[skip ci] #9999: Update CONTRIBUTING.md` + ### Documentation - Any API changes must be accompanied with appropriate documentation changes.