agentleFS
Sign inStart free
jhermannjhermann/ice-creamery/.github/copilot-instructions.md

ice-creamery

Copilot instructions185 starsChanged 6 months agoMITView on GitHub

  • Installs packages

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

4 rules. About 0 are common, 1 is distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

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

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

    Follow PEP 8 and .github/instructions/python-style.instructions.md.

    line 18
  2. Very specific:

    Use only pytest for tests.

    line 37
  3. Distinctive:

    Use MkDocs Material theme.

    line 43
  4. Very specific:

    Follow .github/instructions/secure-development.instructions.md for all code changes.

    line 48

≈ “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 Instructions for ice-creamery

Build, Test, and Lint Commands

  • Install dependencies:
    python3 -mpip install -r ./requirements.txt
  • Run all tests:
    pytest
  • Run a single test file:
    pytest tests/test_utils.py
  • Linting:
    • Follow PEP 8 and .github/instructions/python-style.instructions.md.
    • Key custom rules: 110-char max lines, 4-space indentation, double-quote preference, and grouped imports.

High-Level Architecture

  • Recipes are stored as Markdown files in recipes/*/README.md, generated from LibreOffice spreadsheets (see recipes/Ice-Cream-Recipes.fods).
  • Scripts in scripts/ automate:
    • Converting recipe sheets to Markdown (ice-cream-recipe.py)
    • Managing and searching recipe sheets (recipe.py)
    • Aggregating docs/recipes into summary files (update-all-md.sh)
  • Shared utilities for scripts are in scripts/_utils.py.
  • Testing uses pytest with tests in tests/, following strict conventions (see .github/instructions/python-tests.instructions.md).
  • Docs are built with MkDocs (mkdocs.yml).
  • Info graphics (e.g., assets/Mindmap-Creami-Lab-core.png) summarize the core concepts: ingredient roles, process mechanics, and key formulation principles for Ninja Creami recipes.

Key Conventions

  • Apply only the conventions relevant to the file type you are editing.
  • Python:
    • Use only pytest for tests; place fixtures in tests/conftest.py.
    • Adhere to the style and test rules in .github/instructions/python-style.instructions.md and .github/instructions/python-tests.instructions.md.
  • Recipe workflow:
    • Edit recipes in the spreadsheet, export as CSV, then convert to Markdown using scripts/ice-cream-recipe.py.
    • Ingredient and process conventions are visualized in assets/Mindmap-Creami-Lab-core.png.
  • Docs:
    • Use MkDocs Material theme. Serve locally with:
      ./linkdocs.sh && mkdocs serve 2>&1 | grep -v 'INFO.*absolute link'
  • Security:
    • Follow .github/instructions/secure-development.instructions.md for all code changes.

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.

  • In this repositoryOne other file it gives its agents.

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