@@ -18,17 +18,20 @@ Thank you for your interest in contributing to **EduVox AI**! This document outl
1818The ` main ` branch is protected with strict rules to ensure code quality and stability:
1919
2020#### ** Required Status Checks** ✅
21+
2122- ** Code Quality & Build Check** - ESLint, TypeScript, and build verification
2223- ** Security & Dependency Check** - Vulnerability scanning and dependency audit
2324- ** All CI/CD pipeline jobs must pass** before merging
2425
2526#### ** Pull Request Requirements** 🔍
27+
2628- ** Require pull request reviews** before merging
27- - ** Require branches to be up to date** before merging
29+ - ** Require branches to be up to date** before merging
2830- ** Restrict direct pushes** to admins only
2931- ** Automatic deletion** of head branches after merge
3032
3133#### ** Quality Standards** 📊
34+
3235- Code must pass ** ESLint** with zero errors
3336- ** TypeScript** compilation must succeed
3437- ** Build process** must complete successfully
@@ -64,23 +67,27 @@ git checkout -b fix/bug-description
6467### ** 3. Development Guidelines**
6568
6669#### ** Code Quality** ✨
70+
6771- Follow ** TypeScript** best practices
6872- Use ** ESLint** and fix all warnings
6973- Write ** clean, readable code** with proper comments
7074- Follow existing ** code style** and patterns
7175
7276#### ** Commit Messages** 📝
77+
7378Use conventional commit format:
79+
7480```
7581feat: add new voice synthesis feature
76- fix: resolve authentication timeout issue
82+ fix: resolve authentication timeout issue
7783docs: update API documentation
7884style: fix code formatting
7985refactor: optimize database queries
8086test: add unit tests for companion creation
8187```
8288
8389#### ** Testing** 🧪
90+
8491- Test your changes thoroughly
8592- Ensure ** build process** works: ` npm run build `
8693- Run ** linting** : ` npm run lint `
@@ -89,6 +96,7 @@ test: add unit tests for companion creation
8996### ** 4. Submitting Changes**
9097
9198#### ** Before Submitting** 📋
99+
92100- [ ] Code passes all ** ESLint** checks
93101- [ ] ** TypeScript** compiles without errors
94102- [ ] ** Build** completes successfully
@@ -125,13 +133,16 @@ This ensures all code goes through proper **CI/CD validation** before reaching p
125133## 🏗️ Development Environment
126134
127135### ** Required Tools** 🛠️
128- - ** Node.js** 18+
136+
137+ - ** Node.js** 18+
129138- ** npm** or ** yarn**
130139- ** Git**
131140- ** VS Code** (recommended)
132141
133142### ** Environment Variables** 🔐
143+
134144Required environment variables (add to ` .env.local ` ):
145+
135146- ` NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY `
136147- ` CLERK_SECRET_KEY `
137148- ` NEXT_PUBLIC_SUPABASE_URL `
@@ -159,4 +170,4 @@ This project follows the **Contributor Covenant Code of Conduct**. Please be res
159170
160171---
161172
162- Thank you for contributing to ** EduVox AI** ! Your contributions help make AI-powered education accessible to everyone. 🎓✨
173+ Thank you for contributing to ** EduVox AI** ! Your contributions help make AI-powered education accessible to everyone. 🎓✨
0 commit comments