agentleFS
Sign inStart free
dougborgdougborg/frontapp-openapi-client/.github/copilot-instructions.md

frontapp-openapi-client

Copilot instructions0 starsChanged 7 months agoMITArchived repositoryView on GitHub

This repository uses Claude Code as its primary AI development harness. For canonical guidance — architecture overview, validation tiers, commit standards, file rules, anti-patterns, and the new-vertical workflow — read: - CLAUDE.md — quick-reference cheat-sheet - AGENT_WORKFLOW.md — step-by-step walkthrough - docs/api-facts.yaml — generated, CI-validated index of every endpoint's response shape, module name quirks, and helper status - docs/adr/ — Architecture Decision Records Never use --no-verify, noqa, type: ignore, or skip a failing check. Fix at the source. See CLAUDE.md…

The file

We split this copilot-instructions.md into the rules it gives an agent

2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Never use --no-verify, noqa, type: ignore, or skip a failing check.

    line 20
  2. Very specific:

    Use ! for breaking changes (feat(client)!: ...).

    line 39

≈ “Common” is an estimate: at least 1 in 5 of the 3,779 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
copilot-instructions.md

GitHub Copilot Instructions

This repository uses Claude Code as its primary AI development harness. For canonical guidance — architecture overview, validation tiers, commit standards, file rules, anti-patterns, and the new-vertical workflow — read:

  • CLAUDE.md — quick-reference cheat-sheet
  • AGENT_WORKFLOW.md — step-by-step walkthrough
  • docs/api-facts.yaml — generated, CI-validated index of every endpoint's response shape, module name quirks, and helper status
  • docs/adr/ — Architecture Decision Records

Validation before pushing

uv run poe agent-check  # Tier 2: format + lint + typecheck (~10s, before commit)
uv run poe check        # Tier 3: above + tests + facts-check (~30s, before PR)

Never use --no-verify, noqa, type: ignore, or skip a failing check. Fix at the source. See CLAUDE.md "Zero Tolerance for Ignoring Errors".

Generated files

Files under frontapp_public_api_client/api/, frontapp_public_api_client/models/, and client.py / client_types.py / errors.py are generated by uv run poe regenerate-client. The vendored OpenAPI spec (docs/frontapp-openapi.yaml) and facts index (docs/api-facts.yaml) are similarly generated. Never edit any of these directly — patch scripts/vendor_spec.py or regenerate.

Conventional commits

feat(client): ...    # → frontapp-openapi-client minor
fix(mcp): ...        # → frontapp-mcp-server patch
docs: ...            # no release

Use ! for breaking changes (feat(client)!: ...). See CLAUDE.md "Commit Standards" for the full type / scope matrix.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free