This section covers workflow, standards, and processes for effective development on the Hatch project.
These documents provide the essential processes, standards, and workflows that developers need to follow when working on the Hatch codebase. They focus on "how to work" rather than "what to implement."
- Developer Onboarding - Quick start guide for new developers joining the project
- Testing Standards - Testing requirements, patterns, and best practices
- Follow organization-wide Python coding standards
- Implement comprehensive error handling and logging
- Write clear, self-documenting code with appropriate comments
- Include docstrings following the organization's docstring standards
- Write tests for all new functionality
- Follow the three-tier testing approach: Development, Regression, Feature
- Ensure adequate test coverage for critical paths
- Use the centralized test runner (
run_tests.py)
- Update documentation when implementing new features
- Follow the organization's documentation guidelines
- Reference API docstrings rather than duplicating implementation details
- Maintain clear cross-references between related topics
All development must follow the organization-wide standards defined in:
instructions/documentation.instructions.md- Documentation standardsinstructions/python_docstrings.instructions.md- Docstring format requirementsinstructions/testing.instructions.md- Testing guidelines
- Architecture - Understanding the system you're working on
- Implementation Guides - Technical how-to guides for specific features
- Contribution Guidelines - Process for contributing your work