rust-unofficial/patterns

Module/code organization

Open

#212 opened on Jan 23, 2021

View on GitHub
 (5 comments) (2 reactions) (0 assignees)Shell (6,622 stars) (292 forks)batch import
A-patternC-additiongood first issue

Description

cargo new already creates a structured project (folders, etc...). Wouldn't be it nice to create a section/page/idioms/ devoted to best practices of code organisation? For example how to struct modules, crates, workspaces...how to refer one crate from another or one module from another. What do you think?

Contributor guide

Tech stack
rust
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic Rust knowledgeFamiliarity with Rust module system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine existing patterns in the repository to identify common code organization practices. Look at the current documentation structure to determine where a new section on module organization would fit. Review comments on this issue for any specific suggestions from maintainers or contributors.