Contributing to MonoForge

Getting Started as a Contributor#

We welcome contributions to MonoForge! Whether adding new telemetry plugins, authoring animated vector characters, fixing bugs, or improving documentation, here is how to get started:

1. Fork the repository on GitHub.
2. Clone your fork locally:

git clone https://github.com/<your-username>/MONOFORGE.git
   cd MONOFORGE

1. Create a topic branch:

git checkout -b feat/my-new-feature

Development Workflow#

MonoForge uses Biome for fast formatting and linting:

# Run Biome lint checks
pnpm lint

# Automatically format code
pnpm format

# Run Vitest test suite
pnpm test

Coding Standards & Conventions#

• Framework: Next.js 16 (App Router) with TypeScript in strict mode.
• Styling: Tailwind CSS utility classes.
• State Management: Zustand store at src/store/useReadmeStore.ts. Do not create secondary state stores.
• Markdown Compiler: Keep src/lib/buildMarkdown.ts pure and side-effect free.
• Commit Messages: Use Conventional Commits (feat:, fix:, docs:, chore:, refactor:).

Pre-PR Checklist#

Before opening a pull request, ensure all verification steps pass:

1. pnpm type-check passes with 0 errors.
2. pnpm test passes all Vitest test suites.
3. pnpm build completes successfully.
4. Any new plugin or markdown feature includes colocated unit tests.