Skip to content

Commit 736c9de

Browse files
jom-sqampcode-com
andcommitted
docs: clarify fork workflow for external contributors
Co-authored-by: Amp <amp@ampcode.com>
1 parent e456e04 commit 736c9de

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,34 @@ Thank you for your interest in contributing! This project is a local web UI for
1212

1313
### Setup
1414

15-
```bash
16-
git clone https://github.com/block/thread-manager-for-amp.git
17-
cd thread-manager-for-amp
18-
pnpm install
19-
pnpm dev
20-
```
15+
> **External contributors**: You don't have push access to this repo — that's normal for open source! You'll need to **fork first**, then clone your fork. See the workflow below.
2116
22-
Open http://localhost:5173
17+
1. **Fork the repository** — Click the "Fork" button on [the repo page](https://github.com/block/thread-manager-for-amp), or use the GitHub CLI:
18+
19+
```bash
20+
gh repo fork block/thread-manager-for-amp --clone
21+
cd thread-manager-for-amp
22+
```
23+
24+
2. **Install dependencies and start dev server**:
25+
26+
```bash
27+
pnpm install
28+
pnpm dev
29+
```
30+
31+
3. Open http://localhost:5173
2332

2433
## Development Workflow
2534

26-
1. Fork and clone the repository
35+
1. Make sure your fork is up to date: `git pull upstream main`
2736
2. Create a feature branch: `git checkout -b my-feature`
2837
3. Make your changes
2938
4. Run tests: `pnpm test`
3039
5. Run checks: `pnpm check` (format check + lint + typecheck + build)
3140
6. Commit with a descriptive message
32-
7. Open a pull request
41+
7. Push to your fork: `git push origin my-feature`
42+
8. Open a pull request from your fork back to `block/thread-manager-for-amp`
3343

3444
## Project Structure
3545

0 commit comments

Comments
 (0)