Repository Structure

This section covers best practices for organizing your scientific software repository. A well-structured repository makes your code more approachable, easier to navigate, and simpler to maintain.

What You’ll Learn

In this section, you’ll discover:

• Documentation organization: Where to place your documentation for maximum visibility and usability
• Source code layout options: The pros and cons of src-layout versus flat-layout structures
• Test organization: How to decide whether tests should be included in your module or kept separate

The repository structure decisions you make early in your project can have long-lasting impacts on development workflow, packaging, and testing. This section will help you make choices that align with community standards and support your specific project needs.