agentleFS
apacheapache/skywalking-banyandb/skills/compiling/SKILL.md

compiling

Skill355 starsChanged 4 months agoApache-2.0View on GitHub

Compile and build the SkyWalking BanyanDB project. Use when the user asks to compile, build, or generate code for this project.

The file

We split this skill into the rules it gives an agent

5 rules. About 0 are common, 2 are distinctive, and 3 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.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Follow these steps to compile the project.

    line 9
  2. Very specific:

    Run make generate first. This regenerates .pb.go files from .proto definitions and mock files via mockgen.

    line 13
  3. Distinctive:

    If generate fails, check:

    line 19
  4. Very specific:

    Run make build to compile all project components: ui, banyand, bydbctl, mcp, fodc/agent, fodc/proxy.

    line 26
  5. Very specific:

    Import errors: Check import aliases match CLAUDE.md conventions (e.g., commonv1, databasev1).

    line 34

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill 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
SKILL.md

Compiling SkyWalking BanyanDB

Follow these steps to compile the project.

Step 1: Generate protobuf and mock code

Run make generate first. This regenerates .pb.go files from .proto definitions and mock files via mockgen.

This step is required whenever:

  • Proto files (.proto) have been added or modified
  • Go interfaces used by mockgen have changed

If generate fails, check:

  • protoc and Go protobuf plugins are installed
  • Proto file syntax is valid
  • Interface signatures match mock expectations

Step 2: Build all binaries

Run make build to compile all project components: ui, banyand, bydbctl, mcp, fodc/agent, fodc/proxy.

Binaries are output to each component's build/bin/dev/ directory.

Troubleshooting

  • Missing fields in .pb.go: Proto files were updated but make generate was not run. Run it first.
  • Mock generation failures: An interface changed but the mock wasn't regenerated. make generate fixes this.
  • Import errors: Check import aliases match CLAUDE.md conventions (e.g., commonv1, databasev1).

Other useful targets

  • make clean — clean all build artifacts
  • make clean-build — clean only build binaries
  • make lint — run linters
  • make test — run tests

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.