Skip to content

Latest commit

 

History

History
122 lines (83 loc) · 4.32 KB

CONTRIBUTING.md

File metadata and controls

122 lines (83 loc) · 4.32 KB

Contributing to Suites

Table of Contents

  1. Introduction
  2. Prerequisites
  3. Getting Started
  4. Contribution Process
  5. Making Changes
  6. Tests and Quality Assurance
  7. Documentation
  8. Continuous Integration
  9. Commit Guidelines
  10. Acknowledgements
  11. Developer Onboarding

Introduction

Welcome to the Suites project! Suites is designed to streamline and enhance testing experiences for developers. As a monorepo project managed with Lerna and divided into several distinct packages, we aim to provide a comprehensive set of tools for testing. This document outlines guidelines for contributing to Suites. We strongly recommend reading the Suites Documentation to fully understand the project's functionality and goals.

Joining Suites means contributing to a mission: enhancing the quality of unit testing and testing processes. Your involvement is key to driving this vision forward and improving Suites.

Prerequisites

  • Node.js: Use Node 26 for development. The supported runtime range is ^22.22.2 || ^24.15.0 || ^26.0.0. CI covers all three major versions.
  • pnpm: Install pnpm 12.16.1, matching the version pinned in package.json. Dependency overrides and approved install scripts live in pnpm-workspace.yaml.

Getting Started

Installation and Setup

  1. Clone the Suites Repository:
    git clone https://github.com/suites-dev/unit.git
  2. Install Dependencies:
    pnpm install --frozen-lockfile

Running Tests

Ensure everything is functioning as expected by running the test suite:

pnpm test

Contribution Process

Reporting Issues and Bugs

Discover a bug? First, check our Issue Tracker. If it's a new issue, create a detailed report including steps to reproduce, expected outcomes, and actual results.

Feature Requests

Ideas for new features are always welcome. Submit your proposal via our GitHub Repository, detailing the feature and its potential benefits to Suites.

Making Changes

Writing Code

Contribute code that is clean, maintainable, and efficient, adhering to Suites's existing style and best practices.

Tests and Quality Assurance

  • Accompany new code with relevant unit or integration tests.
  • Aim for high test coverage – verify with pnpm test.
  • Pass all linting checks using pnpm lint.

Documentation

Document any changes or additions, ensuring the information is clear, accurate, and accessible.

Continuous Integration

All pull requests undergo CI checks for:

  • Test completion.
  • Successful builds.
  • Dependency validation and circular dependency checks.
  • Coverage measurement.

Commit Guidelines

Use conventional commit headers scoped to the affected package:

Scope Package directory
unit packages/unit
core.unit packages/core
types.common packages/types/common
types.di packages/types/di
types.doubles packages/types/doubles
doubles.jest packages/doubles/jest
doubles.vitest packages/doubles/vitest
di.nestjs packages/di/nestjs
di.inversify packages/di/inversify

For example: feat(unit): add a new TestBed option. Mark breaking changes with an explicit BREAKING CHANGE: footer explaining the migration. The Angular changelog parser does not recognize ! in headers.

Keep each package's changes in its scoped commit. Merge multi-package releases with a merge commit or rebase merge, preserving the commits through next to master; squashing loses the package-specific release history.

For detailed guidelines on semantic commits, visit Conventional Commits.

Acknowledgements

We deeply value your contributions. All contributors are recognized in our release notes and we maintain a comprehensive list of contributors.

Developer Onboarding

Stay tuned for our comprehensive Developer Onboarding Guide, launching soon!