microsoft / microsoft/rust-for-dotnet-devs

Rust code examples shouldn't have errors

Open
#11 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
405
Forks
61
Avg merge
9m
Merged PRs (30d)
1

Description

Run mdbook test during CI to ensure that the Rust code examples don't have errors.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Inspect the repository's CI configuration and determine where mdbook test should run. Run the command locally first, then update CI so the check runs automatically and fails when Rust code examples contain errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
ci-cd, documentation, testing-qa
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.