agentleFS
kneavekneave/climate-scheduler/.github/copilot-instructions.md

climate-scheduler

Copilot instructions148 starsChanged 11 months agoMITView on GitHub

These instructions are for AI assistants working in this repository. Before proposing or making changes, establish context in this order: If scope is unclear, default to the smallest set of files needed and ask concise clarifying questions. At minimum, verify impacted files for errors and run focused checks for changed behavior. For scheduling UI changes, verify: - node select/move/delete in active timeline - node select/move/delete in profile timeline - save/debounce behavior - mode/day/profile transitions For backend scheduling changes, verify: -…

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈8

    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. Distinctive:

    Before proposing or making changes, establish context in this order:

    line 7
  2. Distinctive:

    If scope is unclear, default to the smallest set of files needed and ask concise clarifying questions.

    line 18
  3. Very specific:

    Do not manually edit compiled artifacts in custom_components/climate_scheduler/frontend/*.js when TS source exists.

    line 23
  4. Distinctive:

    Keep active timeline and profile timeline behavior consistent when touching node settings.

    line 32
  5. Distinctive:

    Do not remove user-facing safeguards (e.g., delete-last-node protection) unless requested.

    line 33
  6. Distinctive:

    When behavior or contracts change, update as needed:

    line 52
  7. Distinctive:

    Keep documentation concise and operational.

    line 58
  8. Very specific:

    When searching for TODOs/tests/issues, avoid dependency noise by scoping to project files and excluding local virtual environments where …

    line 62
  9. Distinctive:

    If user asks for “review only”, do not modify code.

    line 66
  10. Distinctive:

    If user asks for “review + fix”, patch minimal fixes and summarize risks and validation.

    line 67

≈ “Common” is an estimate: at least 1 in 5 of the 3,669 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

Copilot Project Instructions

These instructions are for AI assistants working in this repository.

1) Startup Context Order (Required)

Before proposing or making changes, establish context in this order:

  1. documents/CONTEXT_SNAPSHOT.md
  2. documents/ARCHITECTURE_MAP.md
  3. documents/CONTRACTS.md
  4. Relevant hotspot guide(s):
    • documents/HOTSPOTS_APP_JS.md
    • documents/HOTSPOTS_COORDINATOR.md
  5. ADR index and relevant ADRs:
    • documents/adr/README.md

If scope is unclear, default to the smallest set of files needed and ask concise clarifying questions.

2) Source-of-Truth Policy (Required)

  • For compiled frontend components, edit only src/*.ts.
  • Do not manually edit compiled artifacts in custom_components/climate_scheduler/frontend/*.js when TS source exists.
  • custom_components/climate_scheduler/frontend/app.js is runtime source and may be edited directly.
  • Respect rollup.config.mjs outputs.

3) Change Safety Rules

  • Make minimal, targeted changes.
  • Preserve event payload contracts unless explicitly changing them and updating docs.
  • Preserve service payload contracts unless explicitly changing them and updating docs.
  • Keep active timeline and profile timeline behavior consistent when touching node settings.
  • Do not remove user-facing safeguards (e.g., delete-last-node protection) unless requested.

4) Required Verification After Edits

At minimum, verify impacted files for errors and run focused checks for changed behavior.

For scheduling UI changes, verify:

  • node select/move/delete in active timeline
  • node select/move/delete in profile timeline
  • save/debounce behavior
  • mode/day/profile transitions

For backend scheduling changes, verify:

  • schedule mode resolution (all_days, 5/2, individual)
  • advance/cancel lifecycle
  • climate_scheduler_node_activated event payload compatibility

5) Documentation Update Rules

When behavior or contracts change, update as needed:

  • documents/CONTEXT_SNAPSHOT.md
  • documents/CONTRACTS.md
  • relevant hotspot guide
  • ADR (if architectural decision with cross-file impact)

Keep documentation concise and operational.

6) Search/Review Hygiene

When searching for TODOs/tests/issues, avoid dependency noise by scoping to project files and excluding local virtual environments where possible.

7) Review Mode Preference

If user asks for “review only”, do not modify code. If user asks for “review + fix”, patch minimal fixes and summarize risks and validation.

Download now (ZIP)

  • Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.

    Of the Copilot instructions files we read, the 2,297 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

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.