agentleFS
Sign inStart free
QuantcoQuantco/dataframely/.github/copilot-instructions.md

dataframely

Copilot instructions623 starsChanged 12 months agoBSD-3-ClauseView on GitHub

This repository uses the Pixi package manager. When editing pixi.toml, run pixi lock afterwards. When running any commands (like pytest), prepend them with pixi run. - Document all public functions/methods and classes using docstrings - For functions & methods, use Google Docstrings and include Args (if there are any arguments) and Returns (if there is a return type). - Do not include type hints in the docstrings - Do not mention default values in the docstrings - Do not write…

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

12 rules. About 0 are common, 8 are distinctive, and 4 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.

  • 4

    Very specific

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

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

    When running any commands (like pytest), prepend them with pixi run.

    line 7
  2. Distinctive:

    Document all public functions/methods and classes using docstrings

    line 13
  3. Distinctive:

    Do not include type hints in the docstrings

    line 16
  4. Distinctive:

    Do not mention default values in the docstrings

    line 17
  5. Distinctive:

    Do not write docstrings for private functions/methods unless the function is highly complex

    line 18
  6. Distinctive:

    Do not manually adjust or add license headers.

    line 22
  7. Distinctive:

    Never use classes for pytest, but only free functions

    line 26
  8. Very specific:

    Do not put __init__.py files into test directories

    line 27
  9. Distinctive:

    All tests should follow the arrange-act-assert pattern.

    line 30
  10. Very specific:

    If two or more tests are structurally equivalent, they should be merged into a single test and parametrized with @pytest.mark.parametrize

    line 45
  11. Distinctive:

    If at least two tests share the same logic in the "arrange" step, the respective logic should be extracted into a fixture

    line 47
  12. Very specific:

    When reviewing code changes, make sure that the SKILL.md is up-to-date and in line with the public API of this package.

    line 52

≈ “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

Dataframely

Package Management

This repository uses the Pixi package manager. When editing pixi.toml, run pixi lock afterwards.

When running any commands (like pytest), prepend them with pixi run.

Code Style

Documentation

  • Document all public functions/methods and classes using docstrings
    • For functions & methods, use Google Docstrings and include Args (if there are any arguments) and Returns (if there is a return type).
    • Do not include type hints in the docstrings
    • Do not mention default values in the docstrings
  • Do not write docstrings for private functions/methods unless the function is highly complex

License Headers

Do not manually adjust or add license headers. A pre-commit hook will take care of this.

Testing

  • Never use classes for pytest, but only free functions
  • Do not put __init__.py files into test directories
  • Tests should not have docstrings unless they are very complicated or very specific, i.e. warrant a description beyond the test's name

  • All tests should follow the arrange-act-assert pattern. The respective logical blocks should be distinguished via code comments as follows:

    def test_method() -> None:
    # Arrange
    ...

    # Act
    ...

    # Assert
    ...
  • If two or more tests are structurally equivalent, they should be merged into a single test and parametrized with @pytest.mark.parametrize
  • If at least two tests share the same logic in the "arrange" step, the respective logic should be extracted into a fixture

Reviewing

When reviewing code changes, make sure that the SKILL.md is up-to-date and in line with the public API of this package.

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 repository2 other files 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