contributing
Contributing
When working inside the Feynman repository, read the repo-root CONTRIBUTING.md and AGENTS.md files for project-specific conventions.
Use this skill when working on Feynman itself, especially for:
- CLI or runtime changes in
src/ - prompt changes in
prompts/ - bundled skill changes in
skills/ - subagent behavior changes in
.feynman/agents/ - install, packaging, or release changes in
scripts/,README.md, or website docs
Minimum local checks before claiming the repo change is done:
npm test
npm run typecheck
npm run build
If the docs site changed, also validate website/.
When changing release-sensitive behavior, verify that .nvmrc, package engines, runtime guards, and install docs stay aligned.
More from getcompanion-ai/feynman
eli5
Explain research, papers, or technical ideas in plain English with minimal jargon, concrete analogies, and clear takeaways. Use when the user says "ELI5 this", asks for a simple explanation of a paper or research result, wants jargon removed, or asks what something technically dense actually means.
18alpha-research
Search, read, and query research papers via the `alpha` CLI (alphaXiv-backed). Use when the user asks about academic papers, wants to find research on a topic, needs to read a specific paper, ask questions about a paper, inspect a paper's code repository, or manage paper annotations.
18deep-research
Run a thorough, source-heavy investigation on any topic. Use when the user asks for deep research, a comprehensive analysis, an in-depth report, or a multi-source investigation. Produces a cited research brief with provenance tracking.
15literature-review
Run a literature review using paper search and primary-source synthesis. Use when the user asks for a lit review, paper survey, state of the art, or academic landscape summary on a research topic.
15autoresearch
Autonomous experiment loop that tries ideas, measures results, keeps what works, and discards what doesn't. Use when the user asks to optimize a metric, run an experiment loop, improve performance iteratively, or automate benchmarking.
14paper-writing
Turn research findings into a polished paper-style draft with sections, equations, and citations. Use when the user asks to write a paper, draft a report, write up findings, or produce a technical document from collected research.
14