Mahdaad Dev Handbook

Appearance

Processes and Workflows ​

Introduction ​

This section includes work processes and development methods for the project.

Development Process ​

Scrum Bases.

Processes and Workflows ​

Click on the links below to read the comprehensive process document in detail.

View Glossary document →

View Defenition of Done document →

View Defenition Of Ready document →

View QA Enter Criteria document →

View User Story Intake Form document →

View Examples document →

Git Workflow ​

Branch Strategy ​

main (production)
├── develop (integration)
├── feature/user-authentication
├── feature/payment-system
└── hotfix/critical-bug

Branch Naming ​

  • feature/feature-name - for new features
  • bugfix/bug-description - for bug fixes
  • hotfix/critical-issue - for critical issues
  • refactor/component-name - for code refactoring

Commit Messages ​

feat: add user authentication system
fix: resolve login form validation issue
docs: update API documentation
style: format code according to style guide
refactor: simplify user service logic
test: add unit tests for user component
chore: update dependencies

Code Review Process ​

Before Review ​

  • [ ] Code is linted
  • [ ] Tests are written
  • [ ] Tests pass
  • [ ] Documentation is updated

During Review ​

  • Review code quality
  • Review performance
  • Review security
  • Review accessibility
  • Review tests

After Review ​

  • Apply suggested changes
  • Re-test
  • Request re-review (if needed)

Release Process ​

Release Planning ​

  1. Feature Freeze - stop adding new features
  2. Bug Fixes - fix critical bugs
  3. Testing - complete testing
  4. Documentation - update documentation
  5. Release Notes - write release notes

Release Types ​

  • Major - breaking changes
  • Minor - new features
  • Patch - bug fixes

Release Checklist ​

  • [ ] All tests pass
  • [ ] Performance tests succeed
  • [ ] Security scan is done
  • [ ] Documentation is updated
  • [ ] Release notes are written
  • [ ] Rollback plan is ready

Communication ​

Team Communication ​

  • Waves - daily communication
  • Video Calls - meetings
  • Documentation - documentation

Tools & Platforms ​

Project Management ​

  • Oktuple - task management
  • Gitea - version control
  • Figma - design

Development ​

  • Cursor - IDE
  • VS Code - IDE
  • Terminal - command line
  • Insomnia - API testing
  • Postman - API testing
  • Chrome DevTools - debugging

Testing ​

  • Vitest - unit testing
  • Playwright - E2E testing
  • Lighthouse - performance testing

Deployment ​

  • Teamcity - CI/CD
  • Sentry - error tracking