Skip to content

Commit a080193

Browse files
committed
refactor: replace standards submodule with local docs/standards/
- Drop the jewzaam/standards submodule; AP-specific docs now live inline in docs/standards/ (ap-common-usage.md, naming.md, index.md) - Reference upstream jewzaam/standards by URL for general standards - Update CLAUDE.md and README.md to point at the new locations - Remove TODO.md (no longer relevant) - Bump setuptools build requirement to >=64 (PEP 660) and drop pyproject.toml from the install-dev path so the lint/links workflow works in build envs that ship older setuptools Assisted-by: Claude Code (Claude Opus 4.7)
1 parent 0ab0a8f commit a080193

10 files changed

Lines changed: 187 additions & 309 deletions

File tree

.gitmodules

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,3 @@
2525
[submodule "ap-copy-master-to-blink"]
2626
path = ap-copy-master-to-blink
2727
url = https://github.com/jewzaam/ap-copy-master-to-blink.git
28-
[submodule "standards"]
29-
path = standards
30-
url = https://github.com/jewzaam/standards.git

CLAUDE.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ ap-base/
2121
├── ap-move-master-to-library/ # Calibration frame organization
2222
├── ap-move-raw-light-to-blink/ # Light frame organization
2323
├── ap-preserve-header/ # FITS header management
24-
├── docs/ # Centralized documentation
25-
├── standards/ # Project standards submodule
24+
├── docs/ # Centralized documentation (includes docs/standards/)
2625
├── Makefile # Development and validation targets
2726
├── CLAUDE.md # This file (workflow instructions)
2827
└── .gitmodules # Submodule configuration
@@ -60,15 +59,11 @@ To make changes to submodules:
6059

6160
## Project Standards
6261

63-
See [standards/](standards/standards/index.md) for detailed documentation:
62+
AP-specific standards live in [docs/standards/](docs/standards/index.md):
6463

65-
- [ap-common Usage](standards/standards/ap-common-usage.md) - Use shared constants from ap-common
66-
- [Project Structure](standards/standards/project-structure.md) - Directory layout and required files
67-
- [README Format](standards/standards/readme-format.md) - README structure and content
68-
- [Makefile](standards/standards/makefile.md) - Build targets and conventions
69-
- [GitHub Workflows](standards/standards/github-workflows.md) - CI/CD configuration
70-
- [Testing](standards/standards/testing.md) - Unit testing conventions
71-
- [CLI](standards/standards/cli.md) - Command-line interface conventions
64+
- [ap-common Usage](docs/standards/ap-common-usage.md) - Use shared constants from ap-common
65+
66+
For general software-engineering standards (Python style, naming, project structure, Makefile, GitHub workflows, testing, CLI, versioning, etc.), see [jewzaam/standards](https://github.com/jewzaam/standards).
7267

7368
## Working with Submodules
7469

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ deinit:
3232
@echo "Submodules fully cleaned. Run 'make init' to reinitialize."
3333

3434
install-dev:
35-
$(PYTHON) -m pip install -e ".[dev]"
35+
$(PYTHON) -m pip install linkchecker pymarkdownlnt
3636

3737
check: links markdown-lint submodule-links
3838

README.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@ ap-base/
2626
├── ap-move-master-to-library/ # Calibration frame organization
2727
├── ap-move-raw-light-to-blink/ # Light frame organization
2828
├── ap-preserve-header/ # FITS header management
29-
├── docs/ # Centralized documentation
30-
├── standards/ # Project standards submodule
29+
├── docs/ # Centralized documentation (includes docs/standards/)
3130
├── Makefile # Submodule management
3231
└── CLAUDE.md # Claude Code workflow instructions
3332
```
@@ -56,23 +55,17 @@ make init # Reinitialize fresh submodules
5655

5756
## Working with Standards
5857

59-
Standards are defined in the `standards/standards/` directory and apply to all submodule projects:
58+
AP-specific standards live in [`docs/standards/`](docs/standards/index.md):
6059

61-
- [Project Structure](standards/standards/project-structure.md) - Directory layout and required files
62-
- [README Format](standards/standards/readme-format.md) - README structure and content
63-
- [Makefile](standards/standards/makefile.md) - Build targets and conventions
64-
- [GitHub Workflows](standards/standards/github-workflows.md) - CI/CD configuration
65-
- [Testing](standards/standards/testing.md) - Unit testing conventions
66-
- [CLI](standards/standards/cli.md) - Command-line interface conventions
67-
- [Naming Conventions](standards/standards/naming.md) - File and variable naming
60+
- [ap-common Usage](docs/standards/ap-common-usage.md) - Use shared constants from ap-common
6861

69-
See [standards/index.md](standards/standards/index.md) for the complete standards documentation.
62+
For general software-engineering standards (project structure, README format, Makefile, GitHub workflows, testing, CLI, naming, etc.), see [jewzaam/standards](https://github.com/jewzaam/standards).
7063

7164
### Enforcing Standards
7265

7366
When making changes to submodule projects:
7467

75-
1. Review relevant standards in `standards/standards/`
68+
1. Review AP-specific standards in [`docs/standards/`](docs/standards/index.md) and general standards at [jewzaam/standards](https://github.com/jewzaam/standards)
7669
2. Ensure changes conform to established conventions
7770
3. Update standards documentation if introducing new patterns
7871
4. Apply changes consistently across all affected submodules
@@ -99,7 +92,7 @@ make init
9992

10093
# Make changes to each submodule's README
10194
cd ap-common
102-
# Edit README.md to match standards/standards/readme-format.md
95+
# Edit README.md to match the README format standard at https://github.com/jewzaam/standards
10396
git add README.md
10497
git commit -m "Update README to match ap-base standards"
10598
git push

TODO.md

Lines changed: 0 additions & 280 deletions
This file was deleted.

0 commit comments

Comments
 (0)