Contributing

Updated May 9, 2026

Thank you for your interest in contributing to Fairspec TypeScript! This document provides guidelines and instructions for contributing to this project.

Project Overview

Project is a monorepo with the following packages:

@faispec/metadata: Core metadata functionality
@faispec/dataset: File-related functionality
@faispec/table: Table-related functionality
@faispec/extension: Extensions related functionality
@faispec/library: All the above functionality
@faispec/terminal: Terminal interface
faispec: Meta-package that re-exports the underlying functionality

Development Environment

Prerequisites

Node: v24.0.0 or higher
PNPM: v10.0.0 or higher

Setup

Clone the repository

git clone https://github.com/yourusername/fairspec-typescript.git fairspec-typescript
cd fairspec-typescript

Install dependencies
```
pnpm install
```

Development Workflow

Code Style and Quality

We use Biome for linting and formatting, and TypeScript for type checking:

Lint: Check for code issues
```
pnpm run lint
```
Format: Auto-fix formatting issues
```
pnpm run format
```
Type Check: Verify TypeScript types
```
pnpm run type
```
Comprehensive Check: Run lint and type checking
```
pnpm run check
```

Testing

Tests are collocated with the code and use Vitest:

Run All Tests: (includes linting and type checking)
```
pnpm test
```
Run Tests Only: (without linting/type checking)
```
pnpm run spec
```
Run a Specific Test:
```
pnpm exec vitest run aspect/file.ts
```

Dependencies

Update all dependencies to their latest versions:

pnpm run bump

Code Style Guidelines

Use TypeScript with strict type checking
Follow ES modules pattern (import/export)
Tests should be placed in __spec__ directories
Use semicolons as needed (not required everywhere)
Use arrow function parentheses as needed (omitted for single parameters)

Making Changes to the Meta-Package

When adding new functionality:

Add it to the appropriate package first
Ensure it's properly exported from that package
No additional work is needed for the meta-package as it automatically re-exports everything

Submitting Changes

Create a feature branch (git checkout -b feature/your-feature)
Make your changes with appropriate tests
Ensure the code passes all checks: pnpm test
Commit your changes with a descriptive message
Submit a pull request

License

By contributing to Fairspec TypeScript, you agree that your contributions will be licensed under the project's license.

Thank you for your contribution!

Search