documentation-common

Common documentation for all emcd/ projects: language-neutral standards and guidance, plus language-specific overlays.

• Maintenance
  • Repository layout
  • Building the documentation
  • Workflow
• Changelog
  • [Unreleased]
  • [1.0.7] - 2026-11-04
  • [1.0.6] - 2026-11-04
  • [1.0.5] - 2026-10-16
  • [1.0.4] - 2026-10-15
  • [1.0.3] - 2026-10-15
  • [1.0.2] - 2026-10-14
  • [1.0.1] - 2026-10-14
  • [1.0] - 2026-10-14
• Architecture Documentation
  • Where Design Knowledge Goes
  • Directives
• Architecture Documentation (Python)
  • The __ Subpackage Pattern
  • Python Testing Organization
• Code of Conduct
  • Specific Considerations
  • Inspirations
• Contribution
  • Ways to Contribute
  • Development
• Environment
  • Initial Installation
  • Installation Updates
  • Language-Specific Overlays
• Environment (Python)
  • Tooling
  • Git Hooks
  • Refreshing Environments
  • Interpreter
  • Shell
• License
• Maintenance
  • Copier
• Nomenclature
  • Modules, Packages, and Crates
  • Classes
  • Variables and Attributes
  • Constants and Module-Level Variables
  • Functions
  • Environment Variables
  • Linguistic Consistency
• Latin-derived Verb Vocabulary
  • Verb Prefixes by Semantic Cluster
• Germanic-derived Verb Vocabulary
  • Germanic Naming Philosophy
  • Verb Prefixes by Semantic Cluster
• Practices
  • General Principles
  • Language And Workflow Overlays
• Python Development Guide
  • Comprehensive Example: Data Processing
  • Module Organization
  • Imports
  • Type Annotations
  • Function Signatures
  • Immutability
  • Exceptional Conditions
  • Documentation
  • Formatting Standards
  • Quality Assurance
• Rust Development Guide
  • Module Organization
  • Naming Conventions
  • Documentation
  • Formatting Standards
  • Testing
  • Future Development
• TOML Configuration Practices
  • Configuration Design
  • Key Naming Conventions
  • Formatting Standards
  • Configuration Organization
• Python: Automatic Formatting
• Releases
  • Release Lifecycle
  • Pre-Release Quality Gate
  • Branching and Tagging
  • Patch Releases
  • Changelog Discipline
  • Post-Release Checklist
  • Language-Specific Overlays
• Releases (Python)
  • Release Process
  • Changelog Entries
• Requirements Documentation
  • Product Requirements Document
  • Requirements Management
  • Integration with Development
• Code Style
  • General
  • Language-Specific Overlays
  • Automation
• Tests
  • Core Testing Principles
  • Public Contracts and Internal Visibility
  • Anti-Patterns to Avoid
  • Test Organization
  • Test Data and Fixtures
  • Validation Workflow
  • Coverage Strategy
  • Troubleshooting Approach
  • Language-Specific Overlays
• Tests (Python)
  • Core Testing Principles
  • Anti-Patterns to Avoid
  • Test Organization
  • Preferred Testing Patterns
  • Testing Strategy by Code Type
  • Development Environment
  • Test Code Standards
  • Advanced Testing Patterns
  • Performance Optimization
  • Coverage Guidelines
  • Pre-Commit Validation
  • Troubleshooting Common Issues
  • Decision Framework
  • Benefits of This Approach
• Validation
  • Validation Outcomes
  • Workflow
  • Language-Specific Overlays
• Validation (Python)
  • Commands
  • Workflow

Indices

• Index

• Search Page