Add Rust language documentation#149
Open
mahendrashelke wants to merge 2 commits intoandrewyng:mainfrom
Open
Conversation
Covers common AI agent pitfalls: pattern matching, numeric casting, checked arithmetic, ownership/borrowing, error handling, enums for domain logic, and security patterns from corrode.dev's "Pitfalls of Safe Rust". Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Author
|
cc @rohitprasad15 — would appreciate a review when you get a chance! |
There was a problem hiding this comment.
Pull request overview
Adds a new Rust language guideline document intended to reduce common incorrect patterns produced by AI agents, with emphasis on ownership/borrowing, error handling, safety/security pitfalls, concurrency, and edition 2024 notes.
Changes:
- Introduces a Rust language guidelines doc with “golden rules” and common pitfalls.
- Adds security-focused guidance (TOCTOU, constant-time comparison, unbounded input) and unsafe-code hygiene tips.
- Includes examples covering error handling, domain modeling with enums, and basic stdlib concurrency.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
… channels example
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
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.
Summary
content/rust-lang/docs/rust/rust/DOC.mdchub build --validate-onlyTest plan
node cli/bin/chub build content/ --validate-onlypasses (1554 docs, 0 warnings)