Skip to content

Repository files navigation

Elixir Research Agent Pack

This repository is organized into two visible top-level directories:

  • agent/: Curated runtime material for a specialized Elixir design agent.
  • research/: Source material, drafts, research notes, validation docs, and finished guide sections.

The hidden .claude/ directory contains local tool settings and is not part of the knowledge pack.

Recommended Agent Load Order

For every design task, load:

  1. agent/00_operating_instructions.md
  2. agent/01_elixir_design_principles.md
  3. agent/retrieval_manifest.yml

Then load only the matching rule cards and examples from agent/rules/ and agent/examples/.

Use research/ as background source material only when the curated agent pack does not cover the topic.

Useful Files

  • agent/USAGE_PROMPT.md: Pasteable prompt for using this pack with a coding agent.
  • agent/rules/TEST001_test_architecture.md: Curated testing guidance from project review.
  • agent/evals/design_agent_eval_prompts.md: Evaluation prompts for checking whether an agent applies the pack correctly.
  • agent/99_expansion_backlog.md: Remaining work to expand coverage.

Validation

Current runnable examples can be checked with:

elixir agent/examples/pattern_matching_examples.exs
elixir agent/examples/control_flow_examples.exs
elixir agent/examples/function_design_examples.exs
elixir agent/examples/testing_patterns_examples.exs
ruby -e 'require "yaml"; YAML.load_file("agent/retrieval_manifest.yml"); puts "manifest ok"'

Markdown examples that require project dependencies are clearly labeled illustrative.

GitHub Copilot Code Review

The repository packages an elixir-code-review Agent Skill in skills/elixir-code-review/. Its reference files are generated from the curated agent/ pack so the runtime guidance has one source of truth.

Build and validate the skill after changing principles, the retrieval manifest, or a rule card:

scripts/build_copilot_skill.sh
scripts/validate_copilot_skill.sh

Install the local skill and instruction templates into an Elixir repository:

scripts/install_copilot_review.sh /path/to/elixir/repository

The installer refuses to overwrite existing Copilot instructions or an existing elixir-code-review skill. Review and commit the generated .github/ files in the target repository.

To publish a version after the changes are committed and pushed:

scripts/validate_copilot_skill.sh --github
gh skill publish --tag v0.1.0

After publishing, install a pinned release into a target repository with:

gh skill install dbernazal/elixir_research elixir-code-review \
  --pin v0.1.0 \
  --dir .github/skills

Use agent/evals/copilot_code_review_eval.md to test the installed skill with paired unsafe and safe draft pull requests before enabling automatic reviews.

About

Elixir content for agents to assess and improve Elixir design and implementations

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages