Skip to content

Commit

Permalink
[skip ci] #12912: Update CONTRIBUTING.md (#12913)
Browse files Browse the repository at this point in the history
  • Loading branch information
blozano-tt authored Sep 20, 2024
1 parent 5626625 commit cee4c7e
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit cee4c7e

Please sign in to comment.