This document provides a structured path for new developers to familiarize themselves with Bayat's development conventions and standards.
Start with these core conventions to get up and running quickly:
-
Git Workflow - Git Flow
- Learn our branching strategy and commit message format
- Set up your local git configuration
-
Development Environment - Environment Setup
- Configure your local development environment
- Install required tools and dependencies
-
Code Quality Basics - Code Reviews
- Understand our code review process
- Learn about our quality expectations
-
Project Structure - Project Templates
- Familiarize with our standard project structure
- Learn which templates to use for different types of projects
Once you've mastered the basics, dive into these areas:
-
Architecture Guidelines - Choose based on your primary role:
- Backend developers: Backend Architecture
- Frontend developers: Frontend Architecture
- Full-stack developers: Review both
-
Security Standards - Security Coding Standards
- Learn our security best practices
- Understand compliance requirements
-
Testing Approach - Testing Standards
- Learn about our testing pyramid
- Understand test coverage expectations
-
CI/CD Practices - CI/CD Standards
- Understand our deployment pipeline
- Learn about environment management
Deepen your knowledge with these more specialized areas:
-
Language-Specific Standards - Choose relevant languages:
-
Framework Standards - Choose relevant frameworks:
-
API Design - API Design Standards
- Learn about our API design principles
- Understand versioning and documentation requirements
-
Performance Engineering - Performance Standards
- Understand performance budgets
- Learn about monitoring and optimization
Keep your skills sharp with ongoing learning:
-
Stay Updated - Regularly review:
-
Contribute Back - Learn how to:
- Suggest improvements
- Participate in convention reviews
-
Mentor Others - After 3+ months:
- Mentorship Program
- Help onboard new team members
If you're joining as a team lead or manager:
- Team Collaboration - Collaboration Guidelines
- Learning Resources - Knowledge Management
- Engineering Governance - Technical Debt Management
If you have questions about these conventions:
- Reach out to your assigned onboarding buddy
- Ask in the #platform-team Slack channel
- Consult the Glossary for terminology clarification