Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
117 lines (85 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

117 lines (85 loc) · 2.73 KB
title Contributing
sidebar
order
2

Thank you for your interest in contributing to frictionless-ts! This document provides guidelines and instructions for contributing to this project.

Project Overview

Project is a monorepo with the following packages:

  • @frictionless-ts/metadata: Core metadata functionality
  • @frictionless-ts/dataset: File-related functionality
  • @frictionless-ts/table: Table-related functionality
  • @frictionless-ts/<name>: Domain-specific functionality
  • frictionless-ts: Meta-package that re-exports the underlying functionality

Development Environment

Prerequisites

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

Setup

  1. Clone the repository

    git clone https://github.com/yourusername/frictionless-ts.git frictionless-ts
cd frictionless-ts

  2. 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 located in __spec__ directories 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 core/actions/__spec__/findTask.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:

  1. Add it to the appropriate package first (core, cli, or cron)
  2. Ensure it's properly exported from that package
  3. No additional work is needed for the meta-package as it automatically re-exports everything

Submitting Changes

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

License

By contributing to frictionless-ts, you agree that your contributions will be licensed under the project's license.

Thank you for your contribution!
⚡