This guide will help you understand our development practices and contribution workflow.
| Topic | File |
|---|---|
| DDD layer placement (architecture) | ddd-layer-placement.md |
| DDD practices (domain patterns) | ddd-practices.md |
| PR review guide for reviewers | pr-review-guide.md |
| Creating roadmap issues | roadmap-issues.md |
| Branching conventions | branching.md |
| Commit process and pre-commit checks | commit-process.md |
| Code quality and linting | linting.md |
| Module organization and imports | module-organization.md |
| Error handling principles | error-handling.md |
| Output handling with UserOutput | output-handling.md |
| Secret handling (sensitive data) | secret-handling.md |
| Working with Tera templates | templates/ |
| Environment variables naming | environment-variables-naming.md |
| Debugging techniques | debugging.md |
| Spell checking and dictionaries | spelling.md |
| Known issues and expected behaviors | known-issues.md |
| Logging best practices | logging-guide.md |
| GitHub Markdown pitfalls | github-markdown-pitfalls.md |
| GitHub Copilot agent configuration | copilot-agent/ |
| Testing conventions and practices | testing/ |
-
Fork and clone the repository
-
Install dependencies using the automated installer:
cargo run --bin dependency-installer install
See Dependency Installer for details.
-
Read the branching guidelines in branching.md
-
Install and run linters as described in linting.md
-
Follow the commit process outlined in commit-process.md
# 1. Create a feature branch (use issue number)
git checkout -b 42-add-your-feature-name
# 2. Make your changes
# ... edit files ...
# 3. Run pre-commit verification script
./scripts/pre-commit.sh
# 4. Commit with conventional format (include issue number)
git add .
git commit -m "feat: [#42] add new testing feature"
# 5. Push and create PR
git push origin 42-add-your-feature-name- Main Documentation - Project documentation organization
- E2E Testing Guide - End-to-end testing setup and usage
- Linting Guide - Detailed linting setup and usage
- Tech Stack - Technology-specific documentation
- Architecture Decisions - Decision records and rationale
- Issues: Check existing GitHub issues
- Discussions: Start a GitHub discussion
- Documentation: Review the docs folder for detailed information
Thank you for contributing! 🎉