anil.recoil.org
OCaml HTML5 parser/serialiser based on Python's JustHTML
Add CLAUDE.md
+54
+54
CLAUDE.md
+54
CLAUDE.md
···
···
1
+
# Monorepo Development Guide
2
+
3
+
This is a monorepo managed by `monopam`. Each subdirectory is a git subtree
4
+
from a separate upstream repository.
5
+
6
+
## Making Changes
7
+
8
+
1. Edit code in any subdirectory as normal
9
+
2. Build and test: `opam exec -- dune build` and `opam exec -- dune test`
10
+
3. Commit your changes to this monorepo with git
11
+
12
+
## Exporting Changes to Upstream
13
+
14
+
After committing changes here, they must be exported to the individual
15
+
repositories before they can be pushed upstream:
16
+
17
+
```
18
+
monopam push
19
+
```
20
+
21
+
This extracts your commits into the individual checkouts in `../src/`.
22
+
You then review and push each one manually:
23
+
24
+
```
25
+
cd ../src/<repo-name>
26
+
git log --oneline -5 # review the changes
27
+
git push origin main # push to upstream
28
+
```
29
+
30
+
## Pulling Updates from Upstream
31
+
32
+
To fetch the latest changes from all upstream repositories:
33
+
34
+
```
35
+
monopam pull
36
+
```
37
+
38
+
This updates both the checkouts and merges changes into this monorepo.
39
+
40
+
## Important Notes
41
+
42
+
- **Always commit before push**: `monopam push` only exports committed changes
43
+
- **Check status first**: Run `monopam status` to see which repos have changes
44
+
- **One repo per directory**: Each subdirectory maps to exactly one git remote
45
+
- **Shared repos**: Multiple opam packages may live in the same subdirectory
46
+
if they share an upstream repository
47
+
48
+
## Troubleshooting
49
+
50
+
If `monopam push` fails with "dirty state", you have uncommitted changes.
51
+
Commit or stash them first.
52
+
53
+
If merge conflicts occur during `monopam pull`, resolve them in this monorepo,
54
+
commit, then the next pull will succeed.