Azure / Azure/azure-sdk-for-rust

Document dependency requirements

Open
#2,475 2 comments 0 reactions 1 assignee Assigned to @danieljurek View on GitHub
blocking-release Docs EngSys
Dominant language
Rust
Stars
884
Forks
365
Avg merge
2d 19h
Merged PRs (30d)
112

Description

Document the dependency requirements for what gets defined in the workspace `Cargo.toml`, and what crates' `Cargo.toml`s can do e.g., `dev-dependencies` to other projects in the repo should always be `path` dependencies, or inherited from the workspace if those are defined as `path` dependencies, as we do for `azure_core_test`.

I can think of two places we could put this, with my preference on the first because it's right in the repo and more likely to be seen.

1. Root `CONTRIBUTING.md` - either a short block of text or, if longer with examples, a link to another doc under the `doc/` folder e.g., `doc/dependencies.md`.
2. As part of the guidelines - probably in .

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.