Skip to content

Repo hygiene: AGENTS.md, copilot-instructions, and deploy/ contributor guidance #55

Description

@devantler

🤖 Generated by the Daily AI Assistant

Problem

This repo lacks the agent / instruction files the rest of the portfolio standardizes on, and its contributor docs don't cover the Crossplane workflow:

  • No AGENTS.md (and therefore no ## Maintenance section for the daily engineer).
  • No .github/copilot-instructions.md — what Copilot code review actually reads; every other portfolio repo carries one.
  • CONTRIBUTING.md documents the generic fork→PR flow but says nothing about authoring deploy/ CRs (Observe-first adoption, external-name annotations, management-policy-except-Delete, the shared kustomize patch).
  • deploy/README.md omits a phase roadmap and the credential-refresh / vault-unreachable behavior (external-secret.yaml refreshInterval: 1h).

Proposed direction

  • Add AGENTS.md (canonical, cross-tool) with a ## Maintenance section + the CLAUDE.md / GEMINI.md shims.
  • Add a concise, review-focused .github/copilot-instructions.md (≤4000 chars; the monorepo's file is the exemplar) covering the Crossplane authoring patterns.
  • Add a "Contributing to declarative state" section to CONTRIBUTING.md, and a phase-roadmap + credential-refresh note to deploy/README.md.

Rough size

S–M — docs / agent-files; can ship incrementally (copilot-instructions + AGENTS.md first).

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions