Skip to content

Commit 509c1a5

Browse files
committed
docs: log follow-up monorepo tasks
1 parent 28f5c63 commit 509c1a5

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Issue: Harden Monorepo Developer Experience
2+
3+
## Summary
4+
5+
Capture follow-up improvements for the freshly scaffolded Turborepo workspace so the developer experience remains predictable and actionable.
6+
7+
## Background
8+
9+
During the initial bootstrap of the repository we identified a few areas that could be smoothed out once the base structure landed (see issue #1). These items do not block day-one usage but will prevent friction for future contributors if tackled soon.
10+
11+
## Proposed Changes
12+
13+
1. **Tighten commit strategy**
14+
- Document or adjust the multi-stage commit approach so related configuration changes land together and the history stays easy to traverse.
15+
16+
2. **Introduce deterministic installs**
17+
- Generate and commit a `pnpm-lock.yaml` (or enable `pnpm install --frozen-lockfile`) to guarantee repeatable dependency resolution.
18+
19+
3. **Seed workspace package targets**
20+
- Add minimal `package.json` files in representative `apps/*` and `services/*` folders with placeholder `dev`, `lint`, and `test` scripts so Turbo tasks run immediately.
21+
22+
4. **Apply Prettier across templates/docs**
23+
- Run Prettier on `docs/` and `.github/` to align with the configured 100 character print width and avoid formatting churn in early contributions.
24+
25+
5. **Document staged commit workflow**
26+
- Add a short guide in `docs/runbooks/` describing when to use multi-stage commits and how to keep them coherent if the pattern returns.
27+
28+
## Acceptance Criteria
29+
30+
- Follow-up issue references this document or is closed once tasks are complete.
31+
- Lockfile checked into the repository and CI verifies it.
32+
- Turbo `lint`/`dev` commands report at least one task executed.
33+
- Documentation and template files match Prettier expectations (no diffs when running `pnpm format:check`).
34+
- Runbook added or existing documentation updated to clarify commit strategy expectations.
35+
36+
## References
37+
38+
- Original scaffolding work: issue #1 (Initialize Monorepo with Turborepo)

0 commit comments

Comments
 (0)