Skip to content

Commit 04b9b61

Browse files
committed
docs: add development workflow guide
Introduce DEVELOPMENT.md as the shared source of truth for repository workflow and document responsibilities, and align README, ARCHITECTURE, and AGENTS with the new split.
1 parent 0c963cd commit 04b9b61

4 files changed

Lines changed: 61 additions & 18 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,8 @@ to review.
1212

1313
## Workflow
1414

15-
- Use Conventional Commits for commit messages.
16-
- Do not create pull requests by default.
17-
- For small changes, commit directly on the default branch.
18-
- For larger changes, create a short-lived branch, finish the work there, merge
19-
it back into the default branch locally, then push.
15+
For shared repository workflow such as verification, commit conventions, branch
16+
usage, and documentation boundaries, follow `DEVELOPMENT.md`.
2017

2118
## Testing
2219

@@ -39,6 +36,7 @@ to review.
3936

4037
## Documentation
4138

39+
- Shared documentation responsibilities are defined in `DEVELOPMENT.md`.
4240
- `README.md` is the human-facing entry point: keep it focused on overview,
4341
setup, and a small amount of stable operational guidance such as local file
4442
locations when that improves usability.

ARCHITECTURE.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This document is the canonical description of the repository's structure and
44
runtime behavior. `README.md` stays focused on the human-facing entry point and
5-
setup flow.
5+
setup flow, and `DEVELOPMENT.md` covers development workflow and verification.
66

77
## Responsibility
88

@@ -81,13 +81,3 @@ These files are created if missing and are intentionally not managed here:
8181
- `~/.zshrc.local`: machine-specific shell settings and secrets.
8282
- `~/.zshrc.env`: early shell environment settings loaded before Oh My Zsh.
8383
- `~/.gitconfig_local`: machine-specific Git includes and identities.
84-
85-
## Verification
86-
87-
Use the repository shell checks as a lightweight contract test for the dotfiles
88-
loader and integrations:
89-
90-
```sh
91-
for test in tests/*.sh; do sh "$test"; done
92-
zsh -n zsh/zshrc
93-
```

DEVELOPMENT.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Development
2+
3+
This document is the canonical description of how to make and verify changes in
4+
this repository. `README.md` is the human-facing entry point,
5+
`ARCHITECTURE.md` covers repository structure and runtime behavior, and
6+
`AGENTS.md` adds agent-specific operating rules.
7+
8+
## Change Scope
9+
10+
Keep changes small, practical, and easy to review. Prefer the existing
11+
structure, naming, and patterns in the repository over new abstractions or
12+
incidental cleanup.
13+
14+
## Verification
15+
16+
Keep verification lightweight and relevant. Use the smallest command that
17+
exercises the changed behavior.
18+
19+
- For documentation-only changes, proofreading and `git diff --check` are
20+
enough.
21+
- For repository-wide shell checks, run:
22+
23+
```sh
24+
for test in tests/*.sh; do sh "$test"; done
25+
zsh -n zsh/zshrc
26+
```
27+
28+
Prefer testing dotfiles contracts such as loader behavior, public environment
29+
controls, conditional branches, bootstrap effects, and a small representative
30+
sample over exhaustive configuration catalogs.
31+
32+
## Git Workflow
33+
34+
Use Conventional Commits, and write commit messages in English.
35+
36+
Do not create pull requests by default.
37+
38+
For small changes, commit directly on the default branch. For larger changes,
39+
create a short-lived branch, finish the work there, merge it back into the
40+
default branch locally, then push.
41+
42+
## Documentation
43+
44+
Prefer SSOT. When a detail already lives in config, scripts, CI definitions, or
45+
source files, docs should point to that authority instead of restating volatile
46+
implementation detail.
47+
48+
- `README.md`: human-facing entry point, overview, setup, and a small amount of
49+
stable operational guidance.
50+
- `ARCHITECTURE.md`: repository structure, runtime behavior, and stable system
51+
contracts shared by humans and agents.
52+
- `DEVELOPMENT.md`: shared development workflow, verification, documentation
53+
boundaries, and git conventions.
54+
- `AGENTS.md`: agent-specific operating constraints and editing guidance.

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
My dotfiles.
44

55
This repository links and loads configuration, and may install zsh plugins
6-
managed by this repository. For architecture and repository conventions, see
7-
[ARCHITECTURE.md](ARCHITECTURE.md).
6+
managed by this repository. For architecture, see
7+
[ARCHITECTURE.md](ARCHITECTURE.md). For development workflow and documentation
8+
responsibilities, see [DEVELOPMENT.md](DEVELOPMENT.md).
89

910
## Supported Environments
1011

0 commit comments

Comments
 (0)