Skip to content

docs: add agent guidance files and update onboarding README#233

Open
rlorenzo wants to merge 2 commits into
mainfrom
agent-files
Open

docs: add agent guidance files and update onboarding README#233
rlorenzo wants to merge 2 commits into
mainfrom
agent-files

Conversation

@rlorenzo

@rlorenzo rlorenzo commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds the AI-agent and design guidance files for the project, and refreshes the README so onboarding is accurate.

Changes

  • New guidance files (source of truth for conventions):
    • CLAUDE.md - environment rules, architecture, DB/EF Core, C# and Vue standards, security, git/branch workflow
    • AGENTS.md - entry point for non-Claude agents; defers to CLAUDE.md
    • DESIGN.md - VIPER2 design system (UC Davis brand tokens, typography, components, accessibility)
    • PRODUCT.md - product context and design principles
  • README:
    • Corrected the pre-commit hook description to match the real hook (builds .NET, then parallel lint + full test suite + build verify, with merge/rebase handling)
    • Added a Jenkins Build Trigger (pre-push hook) setup section
    • Added an AI Agent Tooling (Claude Code) section (guidance files + recommended plugins + Playwright MCP)
    • Added CI status badges (Tests, Code Quality, CodeQL) alongside codecov
    • Bumped IDE prerequisite Visual Studio 2022 -> 2026 for .NET 10
    • Standardized product naming to VIPER2
  • .gitignore: ignore per-developer and local agent artifacts so they stay out of the repo:
    • .claude - per-developer Claude Code config
    • .playwright-mcp/, .impeccable/ - agent testing/working folders (snapshots, logs, screenshots)
    • PLAN-*.md, SMOKETEST-*.md - local agent scratch docs (plans and smoke-test guides)

@codecov-commenter

Copy link
Copy Markdown

Bundle Report

Bundle size has no change ✅

@codecov-commenter

codecov-commenter commented Jun 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 44.51%. Comparing base (1d971df) to head (1f6cd60).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #233   +/-   ##
=======================================
  Coverage   44.51%   44.51%           
=======================================
  Files         895      895           
  Lines       51760    51760           
  Branches     4827     4827           
=======================================
  Hits        23041    23041           
  Misses      28149    28149           
  Partials      570      570           
Flag Coverage Δ
backend 44.67% <ø> (ø)
frontend 41.32% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

rlorenzo added 2 commits June 23, 2026 18:51
- Add CLAUDE.md, AGENTS.md, DESIGN.md, and PRODUCT.md as the source of
  truth for agent, design-system, and product conventions
- README: correct the pre-commit hook description, document the Jenkins
  pre-push hook and Claude Code tooling, add CI status badges, and bump
  the IDE prerequisite to Visual Studio 2026
- Ignore .claude/ (per-developer agent config)
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