Another Useful Reference for the Design and Documentation of Unsafe Code
- Dominant language
- Python
- Stars
- 44
- Forks
- 5
- Avg merge
- 4h 22m
- Merged PRs (30d)
- 6
Description
Hi,
We are a group of researchers who have been working on unsafe Rust for the past few years. Last year, we drafted a document that systematically documents the safe usage of unsafe code, including criteria for soundness encapsulation and guidelines for safety documentation:
[rust-safety-standard](https://github.com/safer-rust/rust-safety-standard/blob/main/rust-safety-standard.md)
We hope this document can serve as a useful reference for the Unsafe Rust Review Skill in this repository.
If there is interest, we would be happy to submit a PR to include or reference it in the repository.
Contributor guide
Research direction
Read the linked rust-safety-standard.md and the repository's Unsafe Rust Review Skill materials first. Clarify whether the project wants to include the document or link to it, then identify the appropriate documentation location; done means an agreed reference or inclusion change, with scope confirmed by maintainers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100