Skip to content

Commit 22e2237

Browse files
committed
chore: add docs/WORKFLOW.md
1 parent a26b3a1 commit 22e2237

1 file changed

Lines changed: 102 additions & 0 deletions

File tree

docs/WORKFLOW.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Development Workflow
2+
3+
## Getting Started
4+
5+
```bash
6+
# Clone the repository
7+
git clone [email protected]:Aimino-Tech/OpenTalk2HTML-NotMD.git
8+
cd OpenTalk2HTML-NotMD
9+
```
10+
11+
## Development Workflow
12+
13+
### 1. Branch Naming
14+
15+
Use **kebab-case** with category prefixes:
16+
17+
| Prefix | Purpose | Branch From | Merge To |
18+
|----------|------------------|-------------|----------|
19+
| `feature/` | New features | `main` | `main` |
20+
| `fix/` | Bug fixes | `main` | `main` |
21+
| `hotfix/` | Critical fixes | `main` | `main` |
22+
| `chore/` | Maintenance | `main` | `main` |
23+
| `docs/` | Documentation | `main` | `main` |
24+
25+
Examples:
26+
```
27+
feature/user-authentication
28+
fix/login-validation
29+
hotfix/security-patch
30+
docs/api-endpoints
31+
```
32+
33+
### 2. Development Cycle
34+
35+
1. **Create** a branch from `main` with an appropriate prefix
36+
2. **Develop** with regular, atomic commits
37+
3. **Rebase** on latest `main` before opening a PR
38+
4. **Open PR** targeting `main`
39+
5. **Address review** feedback
40+
6. **Merge** via squash merge
41+
7. **Delete** the branch after merge
42+
43+
### 3. Commit Conventions
44+
45+
Follow conventional commits:
46+
47+
```
48+
<type>: <short description>
49+
50+
<optional body>
51+
<optional footer>
52+
```
53+
54+
Types: `feat`, `fix`, `chore`, `docs`, `refactor`, `test`, `style`, `perf`
55+
56+
Examples:
57+
```
58+
feat: add user authentication endpoint
59+
fix: resolve race condition in cache layer
60+
docs: update API documentation
61+
```
62+
63+
## Build & Test
64+
65+
```bash
66+
# Install dependencies
67+
npm install
68+
69+
# Run linting
70+
npx @biomejs/biome check .
71+
72+
# Run type checking (if applicable)
73+
npx tsc --noEmit
74+
75+
# Run tests
76+
npm test
77+
78+
# Build
79+
npm run build
80+
```
81+
82+
## Linting & Formatting
83+
84+
This project enforces code quality through automated linting and formatting.
85+
86+
- **Linting rules** are defined in the project's linting configuration
87+
- **Formatting** is automatically checked in CI
88+
- Run linting locally before committing to avoid CI failures
89+
90+
## Pull Request Process
91+
92+
1. Ensure all CI checks pass
93+
2. Request review from at least one maintainer
94+
3. Address all reviewer comments
95+
4. Keep PRs focused — one feature/fix per PR
96+
5. Update PR description with context and testing evidence
97+
98+
## CI/CD
99+
100+
- **CI** runs on every PR: lint → typecheck → test → build
101+
- **Merge requirements**: all CI checks must pass, at least one review approval required
102+
- **Branch protection**: direct pushes to `main` are blocked — all changes must go through PRs

0 commit comments

Comments
 (0)