agentleFS
Sign inStart free
jaseci-labsjaseci-labs/jaseci/.github/copilot-instructions.md

jaseci

Copilot instructions953 starsChanged 3 months agoMITView on GitHub

This monorepo contains: jaclang ships as the single jac binary (a Jac launcher + the bundled JacPython runtime) -- there is no pip-installed jaclang. Build it and put it on PATH with ./scripts/fresh_env.sh (see CONTRIBUTING.md). Run tests through the binary's bundled runner (JAC_TEST_JOBS=auto runs them in parallel): Run the formatting/lint gate (same checks the git hook runs): Import syntax: Entry point:

  • Commits and pushes
  • 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,336 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.

The file

We split this copilot-instructions.md 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. Very specific:

    Run tests through the binary's bundled runner (JAC_TEST_JOBS=auto runs them in parallel):

    line 16
  2. Distinctive:

    Run the formatting/lint gate (same checks the git hook runs):

    line 22
  3. Very specific:

    Target repository: Always create PRs against https://github.com/jaseci-labs/jaseci (not forks).

    line 67
  4. Very specific:

    Release notes: If your PR affects Jac developer experience, add a release-note fragment at …

    line 68
  5. Distinctive:

    Testing: Ensure relevant tests pass before submitting.

    line 70

≈ “Common” is an estimate: at least 1 in 5 of the 3,779 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

Copilot Instructions

Repository Structure

This monorepo contains:

  • jac/: Jac language compiler, runtime, language server, and the client/desktop runtimes (jac/jaclang/client/)
  • jac-byllm/: LLM integration and model-driven features
  • docs/: Documentation site and reference materials
  • scripts/: Build, test, and maintenance scripts

Common Workflows

jaclang ships as the single jac binary (a Jac launcher + the bundled JacPython runtime) -- there is no pip-installed jaclang. Build it and put it on PATH with ./scripts/fresh_env.sh (see CONTRIBUTING.md).

Run tests through the binary's bundled runner (JAC_TEST_JOBS=auto runs them in parallel):

cd jac && JAC_TEST_JOBS=auto jac test tests

Run the formatting/lint gate (same checks the git hook runs):

jac precommit

Package-Specific Notes

jac/ (Compiler & Runtime)

  • Grammar: jac/jaclang/compiler/jac.lark
  • IR: unitree.py (UniTree nodes)
  • Passes: jac/jaclang/compiler/passes/
  • Codegen: jcir_gen_pass.jac, jcir_bc_gen_pass.jac
  • Compiler passes subclass Transform/UniPass with enter_*/exit_* hooks
  • Test fixtures: jac/jaclang/compiler/**/tests/fixtures/
  • For type system work, see .github/agents/type-system-agent.md

jac-byllm/ (LLM Features)

  • Core logic: byllm/lib.py, llm_connector.py
  • Schema definitions: schema.py
  • Examples: examples/agentic_ai/

Client & Desktop Runtimes

  • Now part of jaclang core: jac/jaclang/client/

Jac Language Conventions

Import syntax:

import from module { symbol, another_symbol }
import module as alias;

Entry point:

with entry { /* ... */ }

PR Guidelines

  • Target repository: Always create PRs against https://github.com/jaseci-labs/jaseci (not forks). Use gh pr create --repo jaseci-labs/jaseci.
  • Release notes: If your PR affects Jac developer experience, add a release-note fragment at release_notes/unreleased/<package>/<PR#>.<category>.md.
  • Grouping: Organize related changes under sections like "Type Checking Enhancements" or "Cloud Platform Updates".
  • Testing: Ensure relevant tests pass before submitting.

Quick Reference

  • Jac examples: jac/examples/reference/, jac/examples/*
  • Type system details: .github/agents/type-system-agent.md
  • Compiler passes: jac/jaclang/compiler/passes/
  • LLM examples: jac-byllm/examples/

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