Skip to content

Commit de01d19

Browse files
timvwclaude
andcommitted
docs: clarify fork vs branch workflow for contributors
Update CONTRIBUTING.md to distinguish between: - External contributors: Must fork the repo and create branches in their fork - Maintainers: Can create branches directly in the main repo This clarifies that typical users without write access should use the fork-based workflow, not create branches in timvw/wt directly. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent d6e120a commit de01d19

1 file changed

Lines changed: 39 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,49 @@
22

33
## Development Workflow
44

5-
### Working with Feature Branches
5+
### For External Contributors (Fork-based workflow)
66

7-
To keep `main` stable and avoid breaking the build:
7+
If you don't have write access to the repository:
88

9-
1. **Create a feature branch for your changes:**
9+
1. **Fork the repository** on GitHub
10+
11+
2. **Clone your fork:**
12+
```bash
13+
git clone https://github.com/YOUR-USERNAME/wt.git
14+
cd wt
15+
```
16+
17+
3. **Create a feature branch:**
18+
```bash
19+
git checkout -b feature/your-feature-name
20+
```
21+
22+
4. **Make your changes and commit:**
23+
```bash
24+
git add .
25+
git commit -m "feat: your feature description"
26+
```
27+
28+
5. **Push to your fork:**
29+
```bash
30+
git push -u origin feature/your-feature-name
31+
```
32+
33+
6. **Create a Pull Request** from your fork to `timvw/wt:main`
34+
- Go to https://github.com/timvw/wt
35+
- Click "New Pull Request"
36+
- Select "compare across forks"
37+
- Choose your fork and branch
38+
39+
7. **Wait for CI to pass** and respond to any review feedback
40+
41+
### For Maintainers (Branch-based workflow)
42+
43+
If you have write access to the repository:
44+
45+
1. **Create a feature branch:**
1046
```bash
1147
git checkout -b feature/your-feature-name
12-
# or
13-
git checkout -b fix/bug-description
1448
```
1549

1650
2. **Make your changes and commit:**

0 commit comments

Comments
 (0)