Skip to content

Template compliance - #41

Merged
aarontuor merged 9 commits into
mainfrom
template-compliance
Aug 21, 2026
Merged

Template compliance#41
aarontuor merged 9 commits into
mainfrom
template-compliance

Conversation

@aarontuor

Copy link
Copy Markdown
Contributor

Repository template compliance

Brings the repo in line with the organization template and cleans up prose and dead code found along the way.

CI and community files

  • .github/workflows/ci.yml: runs ruff check src tests, black --check src tests, and the test suite.
  • .github/CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md.
  • pyproject.toml: [tool.ruff] config with target-version = "py312" and per-file E402 ignores for the modules that must set env vars before heavy imports. Adds ruyaml to dependencies.
  • src/ and tests/ are now ruff- and black-clean. use_cases/ is out of CI scope.

Docs

  • CLAUDE.md codifies the prose register (plain, literal language; no change-narration in comments).
  • docs/developer.md refreshed and pointed at the Architecture page; README link fixed.
  • New diagrams embedded in the knowledge-base, memory, observability, provenance, and use-case pages (docs/assets/*.png).
  • docs/memory.md gains a section comparing DSAgt memory with platform-native instruction files.

Code cleanup

  • registry.py: removes the unused SKILLS_COLLECTION and the TOOL_REGISTRY_COLLECTION / SKILL_REGISTRY_COLLECTION aliases; no remaining readers.
  • Module docstrings and comments tree-wide rewritten to describe present behavior rather than the history of how they got there (mcp/server.py, provenance.py, session.py, traces.py, agents, tests).

No behavior changes beyond the dropped constants. Merged with main locally, no conflicts.

aarontuor and others added 7 commits July 8, 2026 15:55
Establish a green lint/format baseline so the new CI can enforce it:
- add [tool.ruff] with per-file-ignores for the intentional post-setup
  imports (E402) in __init__.py, knowledge.py, and the guarded integration
  tests — the only E402s in src/tests, all deliberate.
- fix 3 trivial test lints: two unused locals (F841) and an ambiguous `l`
  loop variable (E741).
- apply black to the 8 drifted files under src/tests.

use_cases/ (contributor scientific scripts) is intentionally left out of the
lint/format gate.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Recreate the community/template files (superseding the stale, hastily-made
copilot/merge-template-repo-updates branch), updated to the current repo:

- .github/workflows/ci.yml — lint (ruff + black --check on src/tests) and a
  non-integration pytest matrix on Python 3.12 & 3.13, all on uv. Complements
  the existing docs.yml (mkdocs build + gh-deploy).
- .github/{CONTRIBUTING,SECURITY,CODE_OF_CONDUCT}.md — placed under .github/
  (GitHub surfaces them from there; keeps root and the docs site clean).
  CONTRIBUTING reflects the real uv workflow and `python -m pytest`; SECURITY
  points at private vulnerability reporting; CODE_OF_CONDUCT is Contributor
  Covenant 2.1.
- docs/developer.md — rewritten from a stub into a real dev guide (setup,
  tests, lint/format, docs, codebase orientation).
- README — fix the broken developer-guide link (developer.md -> docs/developer.md).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ture

- CLAUDE.md: add a "Prose register" house-style rule (plain/direct; no
  anthropomorphism, code-jockey slang, or advertising gloss; changelogs record
  behavior changes, not renames/doc churn) so the convention is written down
  rather than restated each time. Fix this file's own "Bundled assets (shipped
  …)" to "Built-in assets (declared …)".
- docs/developer.md: lead codebase orientation with the Architecture page;
  frame CLAUDE.md accurately as the house-conventions / agent-instructions file
  rather than "the fullest map".

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…his cycle

Add a CLAUDE.md house rule: comments describe what the code does and why it
exists now, never how it used to work or paradigms no longer in the tree (git
holds the history). Rewrite three comments that narrated the change instead of
the present:
- memory.py: state the corrupt-file hazard, not "beats coercing to []".
- provenance.py: state the null-session/ChromaDB hazard, not "(not a .get default)".
- traces.py: describe the same-try ack placement's intent, not "if it raised outside".

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…tree-wide

Remove the unreferenced SKILLS_COLLECTION and the TOOL_/SKILL_REGISTRY_COLLECTION
back-compat aliases (migrate the one test that used TOOL_REGISTRY_COLLECTION to
CODES_COLLECTION) — removing dead names beats commenting on why they linger.

Rewrite comments/docstrings that narrated how the code used to be into
present-tense statements of what it does and why, across registry, knowledge,
session, info, setup_core_kb, mcp/server, and the codex/cline/base agents
(e.g. "no longer forces telemetry" -> "sets no telemetry"; the server docstring
no longer recounts the two-server merge; drop "the bge-base variant we used
previously"). Also fixed a couple of "lives in" anthropomorphisms in passing.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…pendency

Embed per-subsystem PNG diagrams in the knowledge-base, memory, observability,
provenance, and use-case pages. Add a section to memory.md comparing DSAgt
memory with platform-native instruction files. Add ruyaml to dependencies.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@aarontuor
aarontuor requested a review from ajtritt August 21, 2026 17:58
@github-actions

github-actions Bot commented Aug 21, 2026

Copy link
Copy Markdown
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://AI-ModCon.github.io/dsagt/pr-preview/pr-41/

Built to branch gh-pages at 2026-08-21 19:22 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

aarontuor and others added 2 commits August 21, 2026 12:17
torch is locked at 2.2.2 (the last release with x86_64 macOS wheels) and
publishes no cp313 wheels, so the 3.13 test job fails at uv sync. Narrow
requires-python to <3.13 and drop 3.13 from the CI matrix.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
CI resolves the floating ruff>=0.5.0 to 0.16.x, whose expanded default rule
set reports 207 errors that 0.15.20 does not. Pin both linters to the
versions the tree is clean under so CI and local runs agree.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@jychoi-hpc
jychoi-hpc self-requested a review August 21, 2026 19:27

@jychoi-hpc jychoi-hpc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks great.

@aarontuor
aarontuor merged commit f3a4509 into main Aug 21, 2026
4 checks passed
@aarontuor
aarontuor deleted the template-compliance branch August 21, 2026 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants