Skip to content

Commit e4850d3

Browse files
authored
docs(contributing): update setup instructions with actual repo name and upstream remote (#128)
- Replace PROJECT_NAME placeholder with actual repository name (agentready) - Add step to configure upstream remote for syncing with original repository
1 parent 12cc82e commit e4850d3

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,19 @@ Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
1616
1. Fork the repository
1717
2. Clone your fork:
1818
```bash
19-
git clone https://github.com/YOUR_USERNAME/PROJECT_NAME.git
20-
cd PROJECT_NAME
19+
git clone https://github.com/YOUR_USERNAME/agentready.git
20+
cd agentready
2121
```
2222

2323
3. Set up your development environment:
2424

25-
4. Install pre-commit hooks:
25+
4. Add the upstream remote (to sync with the original repository):
26+
```bash
27+
git remote add upstream https://github.com/ambient-code/agentready.git
28+
git fetch upstream
29+
```
30+
31+
5. Install pre-commit hooks:
2632
```bash
2733
pre-commit install
2834
```

0 commit comments

Comments
 (0)