agentleFS
openshiftopenshift/hypershift/.cursor/rules/code-formatting.mdc

hypershift / rules

Cursor rule551 starsChanged 6 months agoApache-2.0View on GitHub

Code formatting rules for the project.

The file

We split this code-formatting.mdc into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    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
  • could be automatic: a setting could enforce it
  1. Very specific:

    Use make lint-fix after writing Go code to automatically fix most linting issues

    line 8
  2. Very specific:

    Run make verify to verify both linting and tests pass before committing

    line 9
  3. Distinctive:

    Always use "When ... it should ..." format for describing test cases when creating unit tests

    line 11
  4. Distinctive:

    Always include unit tests when creating new functions or modifying existing ones

    line 12

≈ “Common” is an estimate: at least 1 in 5 of the 6,668 Cursor rule 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
code-formatting.mdc
---
description: Code formatting rules for the project.
globs: 
alwaysApply: true
---
# Code quality, formatting and conventions

- Use `make lint-fix` after writing Go code to automatically fix most linting issues
- Run `make verify` to verify both linting and tests pass before committing
- For markdown files, use `make verify-codespell` to catch spelling errors
- Always use "When ... it should ..." format for describing test cases when creating unit tests
- Always include unit tests when creating new functions or modifying existing ones

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.