How to Contribute to the Egonex-AI Understand Anything Project: A Complete Guide

You can contribute to Understand Anything by forking the repository, setting up the pnpm monorepo with Node ≥ 22, and submitting pull requests that follow conventional commit conventions and include Vitest coverage.

Understand Anything is a multi-agent, tree-sitter-plus-LLM code-analysis platform that transforms massive codebases into interactive knowledge graphs. Contributing to the Egonex-AI Understand Anything project involves working within a structured pnpm monorepo that separates static analysis logic from the React 18 dashboard interface.

Prerequisites and Environment Setup

The project requires Node.js ≥ 22 and pnpm ≥ 10 to manage the monorepo dependencies. All contribution workflows begin with the standard fork-branch-PR model documented in CONTRIBUTING.md.

Fork and Clone the Repository

Start by forking the repository on GitHub, then clone your fork locally:

git clone https://github.com/YOUR_USERNAME/Understand-Anything.git
cd Understand-Anything

Install Dependencies

Install all monorepo dependencies using pnpm:

pnpm install

Build the Core Package

Before running tests or making changes, build the core package to generate TypeScript types:

pnpm --filter @understand-anything/core build

Verify Your Setup

Run the full test suite to ensure your environment is correctly configured:

pnpm --filter @understand-anything/core test
pnpm --filter @understand-anything/skill test
pnpm test   # Runs all packages

Where to Contribute

The monorepo organizes code into two primary packages under understand-anything-plugin/packages: @understand-anything/core (static analysis engine) and @understand-anything/dashboard (React 18 UI). Choose your contribution area based on your expertise.

Core Engine (@understand-anything/core)

Work on the static analysis engine located in understand-anything-plugin/packages/core/src/** to improve tree-sitter parsing accuracy, add new language extractors, or optimize incremental change detection algorithms.

Dashboard UI (@understand-anything/dashboard)

Contribute to the React 18 interface in understand-anything-plugin/packages/dashboard/src/** to add keyboard shortcuts, refine graph layouts using React Flow, update TailwindCSS v4 theme colors, or improve accessibility. The graph layout logic resides in packages/dashboard/src/components/Graph.tsx, which uses Zustand for state management.

Skill Definitions

Create new /understand-* skills or extend language support by modifying files in understand-anything-plugin/skills/**. Skills define how the AI agents interact with specific codebases and technologies.

AI Agents

Refine prompt templates for the multi-agent pipeline in understand-anything-plugin/agents/**. Key agents include project-scanner, file-analyzer, and architecture-analyzer, each defined in separate markdown files containing role-specific prompt templates.

Documentation and Translations

Update README.md, CONTRIBUTING.md, or add translation files in understand-anything-plugin/skills/understand/locales/*.md and READMEs/README.*.md to support new languages.

Test Coverage

Write Vitest test cases for new functionality in **/*.test.ts files under each package, such as understand-anything-plugin/packages/core/**/*.test.ts.

Development Workflow

Follow the standardized workflow to ensure your changes integrate smoothly into the multi-agent codebase analysis pipeline.

Create a Feature Branch

Always work on a dedicated branch rather than main:

git checkout -b feat/add-dark-mode

Implement and Test

Make your changes in the appropriate package directory. For example, adding a dark-mode toggle to the dashboard requires editing files under packages/dashboard/src/components/.

Add corresponding unit tests:

# Create test file following existing patterns

# packages/dashboard/src/components/DarkModeToggle.test.ts

Run the full test suite before committing:

pnpm test

Commit with Conventional Messages

Use conventional commit prefixes (feat:, fix:, docs:, test:) as specified in CONTRIBUTING.md:

git add .
git commit -m "feat: add dark-mode toggle to dashboard"

Submit Your Pull Request

Push your branch and open a Pull Request on GitHub:

git push origin feat/add-dark-mode

Link any related issues in your PR description and ensure all checklist items are satisfied.

Pull Request Requirements

Every contribution must meet the quality standards defined in the CONTRIBUTING.md PR checklist:

• Code style: Follow ESLint/Prettier rules with 2-space indentation and strict TypeScript configuration.
• Test coverage: All new code must include Vitest unit tests.
• CI passing: pnpm test must pass for the entire monorepo.
• Documentation: Update README, skill documentation, or translation files to reflect changes.
• Commit hygiene: Use conventional commit prefixes and remove stray console.log statements.

Summary

• Understand Anything is a pnpm monorepo requiring Node ≥ 22 and pnpm ≥ 10.
• Core contributions target understand-anything-plugin/packages/core/src/** for tree-sitter parsing improvements.
• UI contributions target understand-anything-plugin/packages/dashboard/src/** using React Flow and Zustand.
• Agent contributions involve refining prompts in understand-anything-plugin/agents/**.
• Always run pnpm --filter @understand-anything/core build before testing and pnpm test before submitting.
• Follow conventional commits (feat:, fix:, docs:) and maintain strict TypeScript with 2-space indentation.

Frequently Asked Questions

What are the system requirements for contributing to Understand Anything?

You need Node.js version 22 or higher and pnpm version 10 or higher installed on your system. The project uses pnpm workspaces to manage the monorepo structure, and attempting to use npm or yarn will result in dependency resolution errors.

How do I run tests for only the core package?

Use the pnpm filter flag to target specific packages: pnpm --filter @understand-anything/core test runs only the core engine tests, while pnpm --filter @understand-anything/skill test runs skill-specific tests. Run pnpm test from the root to execute the full suite across all packages.

Where should I start if I want to add support for a new programming language?

Add new language extractors to the core engine in understand-anything-plugin/packages/core/src/** and create corresponding skill definitions in understand-anything-plugin/skills/**. You will also need to update the tree-sitter parsing logic to handle the new language's grammar and import mapping.

What makes a contribution likely to be accepted quickly?

Contributions that include comprehensive Vitest test coverage, follow the 2-space indentation and ESLint rules, use conventional commit messages, and update relevant documentation in README.md or understand-anything-plugin/skills/understand/locales/ align with the project's standards and typically move through review faster.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}