agentleFS
Sign inStart free
genlayerlabsgenlayerlabs/genlayer-studio/AGENTS.md

genlayer-studio

AGENTS.md180 starsChanged 8 months agoMITView on GitHub

  • Reads credentials
  • Installs packages

The file

We split this AGENTS.md into the rules it gives an agent

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

  • 2

    Very specific

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

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

    Place new backend tests in the closest scope folder and name them test_<feature>.py so Pytest auto-discovers them.

    line 23
  2. Very specific:

    Write Conventional Commits (feat:, fix:, refactor:).

    line 29
  3. Distinctive:

    Ensure CI checks succeed, respond to reviewer feedback promptly, and prefer squash merges to keep history tidy.

    line 32

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md 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
AGENTS.md

Repository Guidelines

Project Structure & Module Organization

  • backend/: Python services for consensus, rollup, and RPC endpoints; FastAPI bootstraps in asgi.py and uvicorn_config.py.
  • frontend/: Vite + Vue 3 client with TypeScript sources in src/, assets in public/, and Vitest specs under test/.
  • tests/: Pytest suites split by scope (unit/, integration/, e2e/, load/) with fixtures and factories in common/.
  • hardhat/: Solidity scripts used when simulating L1/L2 interactions through the Hardhat profile.
  • docker/, docker-compose*.yml, and scripts/: container orchestrators and developer utilities used in CI pipelines.

Build, Test, and Development Commands

  • cp .env.example .env && docker compose up: launches the full stack; add -d for background runs.
  • docker compose up jsonrpc webrequest ollama database-migration postgres: backend services only, ideal when pairing with a hot-reload frontend.
  • cd frontend && npm install && npm run dev: start the Vue dev server on port 5173.
  • cd frontend && npm run build: perform type-checking and emit production assets in dist/.
  • pytest: execute Python suites; layer filters with -k or -m to target specific modules.

Coding Style & Naming Conventions

  • Target Python 3.12, use 4-space indentation, and rely on Black via pre-commit for formatting consistency.
  • Vue/TypeScript code follows the ESLint + Prettier toolchain; prefer PascalCase components, camelCase stores and utilities, and kebab-case Vue file names.
  • Align filenames with their behavior (validators/llm_validator.py, frontend/src/modules/network/useNetworkStore.ts) and mirror that pattern in tests.

Testing Guidelines

  • Place new backend tests in the closest scope folder and name them test_<feature>.py so Pytest auto-discovers them.
  • Frontend unit tests live in frontend/test/unit; run npm run test during development and npm run coverage for V8 reports.
  • End-to-end coverage relies on Mocha + Selenium; run npm run test:e2e against a npm run preview instance before opening PRs.
  • Share fixtures or sample payloads through tests/common to keep validator and RPC scenarios deterministic.

Commit & Pull Request Guidelines

  • Write Conventional Commits (feat:, fix:, refactor:); the commit-msg hook validates the prefix and scope.
  • Install hooks with pre-commit install, then run pre-commit run --all-files before pushing to catch formatting and lint issues early.
  • Open PRs from topic branches, link the related GitHub issue, and fill the PR template, including screenshots for UI adjustments and manual test notes.
  • Ensure CI checks succeed, respond to reviewer feedback promptly, and prefer squash merges to keep history tidy.

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.

Check your setup, free