Skip to content

docs: update python instructions and add pytest guide#23

Merged
yxbh merged 3 commits intomainfrom
chore/update-instructions
Feb 27, 2026
Merged

docs: update python instructions and add pytest guide#23
yxbh merged 3 commits intomainfrom
chore/update-instructions

Conversation

@yxbh
Copy link
Owner

@yxbh yxbh commented Feb 27, 2026

Summary

Updates agent instructions after evaluating github/awesome-copilot for applicable content.

Changes

python.instructions.md — Updated to match actual repo conventions:

  • Line length: 79 → 100 (matches ruff config in pyproject.toml)
  • Type hints: typing.List/typing.Dict → modern list[str]/dict[str, int]/X | None
  • Added bdpl-specific conventions: from __future__ import annotations, slots=True dataclasses, struct-based binary parsing, typer/rich
  • Added ruff check/format as pre-commit step
  • Removed over-commenting guidance ("comment every function") in favor of "only comment what needs clarification"

pytest.instructions.md — New file with project-specific testing patterns:

  • Documents the fixture architecture (session-scoped disc analysis, _fixture_path/_analyze_fixture helpers)
  • Per-disc integration test patterns with examples
  • Matrix test conventions (all 6 parametrizations to update)
  • Fixture directory structure rules (files go under disc{N}/, NOT disc{N}/BDMV/)
  • Running tests cheat sheet

awesome-copilot evaluation

Reviewed ~60 instructions and ~80 skills from github/awesome-copilot. Findings:

Content Verdict
python.instructions.md Already had — but ours was the generic version with wrong line length. Now customized.
code-review-generic.instructions.md Already have — identical to upstream
security-and-owasp.instructions.md Already have — comprehensive
agent-safety.instructions.md Not relevant — targets AI agent frameworks (LangChain, etc.)
update-docs-on-code-change Interesting concept but over-engineered for this project
Framework-specific (React, Angular, ASP.NET, etc.) Wrong tech stack
No pytest, ruff, typer, or binary-parsing instructions exist Created our own pytest one

yxbh and others added 3 commits February 27, 2026 23:06
- Update python.instructions.md to match actual repo conventions:
  100-char line length, modern type syntax, from __future__ import
  annotations, slots=True dataclasses, ruff tooling
- Add pytest.instructions.md with project-specific testing patterns:
  fixture structure, disc analysis helpers, matrix test conventions,
  per-disc integration test patterns

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Track which files came from github/awesome-copilot vs project-specific,
and whether upstream copies have been customized. Aids future sync.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
List every specific change made to python.instructions.md vs upstream,
so future syncs know exactly what to preserve.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@yxbh yxbh merged commit d4d9926 into main Feb 27, 2026
1 check passed
@yxbh yxbh deleted the chore/update-instructions branch February 27, 2026 13:49
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.

1 participant