Documentation updates #3402
Merged
Documentation updates #3402
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
danieljurek
requested review from
LarryOsterman,
RickWinter,
hallipr,
heaths,
ronniegeraghty and
weshaggard
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for the Azure SDK for Rust's engineering system checks and dependency management strategy. It addresses issues #2043 and #2044 by providing clear guidance on pipeline checks and versioning conventions.
Key Changes:
- New documentation file describing the Rust-specific checks and tools used in the CI/CD pipeline
- Added versioning and dependency management guidelines to the contributing guide
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| eng/doc/checks.md | New documentation file detailing standard and Rust-specific checks including cargo fmt, clippy, check, doc, docs-rs, deny, and semver checks with command examples |
| CONTRIBUTING.md | Added "Releases" section documenting versioning conventions, workspace dependencies, and version increment strategies for Azure SDK for Rust libraries |
Some of this is what I get for not using a local editor with cspell Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
heaths
requested changes
Dec 8, 2025
heaths
approved these changes
Dec 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #2043
Fixes #2044
Documents pipeline checks and outlines dependency/version strategy.