Skip to content

Commit 4cbc98f

Browse files
committed
docs: Add CONTRIBUTING.md with Branch/PR workflow
1 parent d8ee418 commit 4cbc98f

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing to System Design Masterclass
2+
3+
## 🚀 The Golden Rule: Branch & Merge
4+
We follow a strict **Feature Branch Workflow** to ensure stability.
5+
The `main` branch should always be deployable (and passing tests).
6+
7+
### 1. Create a Branch
8+
Never work on `main` directly.
9+
```bash
10+
git checkout -b feat/my-new-feature
11+
# or
12+
git checkout -b fix/concurrency-bug
13+
```
14+
15+
### 2. Verify Locally
16+
Before pushing, ensure you haven't broken anything.
17+
```bash
18+
make test
19+
```
20+
21+
### 3. Push & Open Pull Request
22+
```bash
23+
git push origin feat/my-new-feature
24+
```
25+
- Go to GitHub and open a **Pull Request (PR)**.
26+
- **Wait for CI**: Our GitHub Actions pipeline will automatically run.
27+
- **Green Check?** ✅ -> Safe to Merge.
28+
- **Red X?** ❌ -> Fix code, commit, and push again (PR updates automatically).
29+
30+
### 4. Code Style
31+
- **Python**: We use `pylint` and `pytest`.
32+
- **Naming**: Snake_case for functions/files (`01_rate_limiter.py`).
33+
- **Simulations**: Scripts should demonstrate a concept and exit gracefully.
34+
35+
---
36+
*Happy Coding!*

0 commit comments

Comments
 (0)