rodin/rust-patterns
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add sources/ to structure for consistency with elixir/go repos

Browse Source
This commit is contained in:
Rodin
2026-05-08 01:12:33 +00:00
parent fd8c799677
commit 6338ab7668
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3
View File
@@ -14,6 +14,7 @@ These are derived from what the [Rust standard library](https://github.com/rust-
- `patterns/` — what to do (error handling, ownership, traits, concurrency, unsafe, macros, etc.) - `patterns/` — what to do (error handling, ownership, traits, concurrency, unsafe, macros, etc.)
- `smells/` — what NOT to do (anti-patterns, common mistakes) - `smells/` — what NOT to do (anti-patterns, common mistakes)
- `sources/` — reference material from specific projects. Study for ideas, don't copy blindly.
## How to use ## How to use
@@ -54,6 +55,8 @@ Give your agent these instructions depending on the task:
**Convention** = descriptive. "Project Z does it this way." Context-specific. Study for ideas — applying another project's conventions to yours without understanding their constraints causes harm. **Convention** = descriptive. "Project Z does it this way." Context-specific. Study for ideas — applying another project's conventions to yours without understanding their constraints causes harm.
The `sources/` directory is convention material absorbed from specific projects. The `patterns/` directory is what you actually follow.
## Source ## Source
All patterns extracted from `library/` at commit [`f53b654`](https://github.com/rust-lang/rust/tree/f53b654a8882fd5fc036c4ca7a4ff41ce32497a6). All patterns extracted from `library/` at commit [`f53b654`](https://github.com/rust-lang/rust/tree/f53b654a8882fd5fc036c4ca7a4ff41ce32497a6).