agentleFS
Sign inStart free
open-telemetryopen-telemetry/opentelemetry-proto/.github/copilot-instructions.md

opentelemetry-proto

Copilot instructions826 starsChanged 4 months agoApache-2.0View on GitHub

First-pass PR review rules for OpenTelemetry Protobuf definitions. Prefer silence over uncertainty. Only flag substantive issues on changed lines. Skip stylistic preferences not listed in the guidelines. Do not nitpick. Do not flag anything CI will catch (compilation errors, buf lint issues, buf breaking violations, or code formatting). When flagging issues, cite the relevant rule and link to CONTRIBUTING.md. Ensure all newly added messages, enums, enum values, fields, and RPCs include a // [Since next] comment annotation per CONTRIBUTING.md#version-annotations-since-labels. Ensure…

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

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

    Prefer silence over uncertainty: Only flag substantive issues on changed lines.

    line 4
  2. Very specific:

    Do not flag anything CI will catch (compilation errors, buf lint issues, buf breaking violations, or code formatting).

    line 7
  3. Distinctive:

    When flagging issues, cite the relevant rule and link to CONTRIBUTING.md.

    line 9
  4. Very specific:

    Ensure all newly added messages, enums, enum values, fields, and RPCs include a // [Since next] comment annotation per …

    line 13
  5. Distinctive:

    Ensure messages and fields have clear, meaningful doc comments written with active verbs or dictionary noun phrases per …

    line 17
  6. Distinctive:

    Ensure all newly defined identifiers align with CONTRIBUTING.md#naming-conventions.

    line 21
  7. Very specific:

    Ensure new experimental signals and capabilities reside in v1development packages and follow …

    line 25

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

OpenTelemetry Proto Repository Instructions

First-pass PR review rules for OpenTelemetry Protobuf definitions. Prefer silence over uncertainty. Only flag substantive issues on changed lines. Skip stylistic preferences not listed in the guidelines. Do not nitpick.

Do not flag anything CI will catch (compilation errors, buf lint issues, buf breaking violations, or code formatting).

When flagging issues, cite the relevant rule and link to CONTRIBUTING.md.

[Versioning] "Since" Annotations

Ensure all newly added messages, enums, enum values, fields, and RPCs include a // [Since next] comment annotation per CONTRIBUTING.md#version-annotations-since-labels.

[Documentation] Explanatory Comments

Ensure messages and fields have clear, meaningful doc comments written with active verbs or dictionary noun phrases per CONTRIBUTING.md#documentation-comments.

[Naming] Protobuf Conventions

Ensure all newly defined identifiers align with CONTRIBUTING.md#naming-conventions.

[Schema Design] Evolution & Package Placement

Ensure new experimental signals and capabilities reside in v1development packages and follow CONTRIBUTING.md#schema-evolution-and-compatibility.

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