Skip to Content
06 ContributingGetting started

Getting started with contributing

This guide helps you set up your development environment and understand the contribution workflow.

Prerequisites

  • Node.js 22+
  • pnpm 8+
  • Git

Setup

Clone the repository:

git clone https://github.com/AlignTrue/aligntrue.git cd aligntrue

Install dependencies:

pnpm install

Build all packages:

pnpm build

Development workflow

Run tests:

pnpm test

Run CLI locally:

cd packages/cli pnpm dev

Contribution guidelines

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes with tests
  4. Run pnpm lint and pnpm test
  5. Submit a pull request

See CONTRIBUTING.md  for detailed guidelines.

Last updated on