Add CI/CD gating overview to CONTRIBUTING guide - #101
quic-aditrath wants to merge 1 commit into
Conversation
Document the automated checks that run against every pull request so contributors know what to expect and how to react when a check fails. Add a CI/CD Gating section covering Pre-flight Checks, Build Gating, and Run-time Validation, and a short note on reviewing job logs and pushing fixes to re-trigger the pipeline on failure. Signed-off-by: Aditya Rathi <aditrath@qti.qualcomm.com>
Qualcomm AI ReviewClick to expand Code ReviewReviewed Commits: f8e9da3
Document the automated checks that run against every pull request so Add a CI/CD Gating section covering Pre-flight Checks, Build Gating, Signed-off-by: Aditya Rathi aditrath@qti.qualcomm.com PR OverviewThis PR adds comprehensive CI/CD documentation to the CONTRIBUTING.md file, explaining the automated checks and gating processes that run on pull requests. Files Changed Summary
Changes SummaryThe PR adds a new "CI/CD Gating" section (lines 30-57) that documents:
Issues Identified
Overall AssessmentThis is a documentation-only change that significantly improves contributor experience by clearly explaining the CI/CD pipeline. The content is well-structured and informative. Only one minor typo was identified. [MAINTAINABILITY] Spelling error in DCO commit instruction - Low SeverityLine 17 contains a spelling error: 'commiting' should be 'committing'. This is a minor typo in the documentation that affects professional presentation. Fixed Code Snippet: 1. Commit your changes using the [DCO](http://developercertificate.org/). You can attest to the DCO by committing with the **-s** or **--signoff** options or manually adding the "Signed-off-by": |
![qualcomm-ai-code-review-assistant[bot]](https://avatars.githubusercontent.com/in/4128059?s=60&v=4){kind=small}
|
|
||
| ### Run-time Validation | ||
|
|
||
| Runs automatically after a successful build gate. Applicable targets are dispatched to a LAVA board-farm for on-device testing, so we catch issues that only surface at runtime. Results are posted back to the PR. If the build gate fails or is skipped, run-time validation won't run. |
There was a problem hiding this comment.
I think we should mention about sequence of event, checker -> public CI -> maintainer approval -> internal CI -> merge, go over what to do if Qualcomm internal CI fails, how to approach maintainer
2 participants
Document the automated checks that run against every pull request so contributors know what to expect and how to react when a check fails.
Add a CI/CD Gating section covering Pre-flight Checks, Build Gating, and Run-time Validation, and a short note on reviewing job logs and pushing fixes to re-trigger the pipeline on failure.