Skip to content

🛠 Development Practices

This directory contains documentation about our software development methodologies, workflows, and best practices. These guidelines help us maintain a consistent and efficient development process.

📚 Available Documents

  1. Git Workflow Our branching strategy, commit message conventions, and PR guidelines.

  2. Testing Strategy Approaches to testing, including unit, integration, and end-to-end testing.

🎯 Core Principles

1. Version Control

  • Use feature branches for all changes
  • Write meaningful commit messages
  • Keep PRs small and focused
  • Review all code before merging

2. Testing

  • Write tests for all new features
  • Maintain high test coverage
  • Test in environments that match production
  • Automate testing where possible

3. Documentation

  • Document public APIs
  • Keep READMEs up to date
  • Document architectural decisions
  • Include setup instructions

🔄 Development Workflow

  1. Plan
  2. Create an issue/ticket
  3. Define acceptance criteria

  4. Break down large tasks

  5. Develop

  6. Create a feature branch
  7. Follow coding standards
  8. Write tests

  9. Document your changes

  10. Review

  11. Open a pull request
  12. Request reviews
  13. Address feedback

  14. Update documentation

  15. Deploy

  16. Run all tests
  17. Get approvals
  18. Merge to main
  19. Deploy to production

🛠 Tools We Use

  • Version Control: Git, GitHub
  • CI/CD: GitHub Actions
  • Code Review: GitHub Pull Requests
  • Documentation: Markdown, MkDocs
  • Project Management: Jira, Linear

📝 Adding New Practices

To propose a new development practice: 1. Create a new markdown file 2. Follow the existing format 3. Include examples and rationale 4. Submit a PR for review 5. Present to the team

❓ Need Help?

  • For Git questions: #git-help
  • For testing help: #testing-help
  • For process questions: #engineering-processes

Last Updated: June 2025