Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
170 lines (115 loc) · 3.67 KB

CONTRIBUTING.md

File metadata and controls

170 lines (115 loc) · 3.67 KB

Contributing to Opsen

Thank you for your interest in contributing to Opsen! This document provides guidelines and information for contributors.

Table of Contents

Getting Started

Before you begin contributing, please ensure you have:

  • Node.js >= 22.0.0
  • pnpm >= 10.12.1 (required package manager)
  • Git

Development Setup

  1. Fork and clone the repository

    git clone https://github.com/your-username/opsen.git
cd opsen

  2. Install dependencies

    pnpm install

  3. Set up Git hooks

    pnpm prepare

  4. Build all packages

    pnpm build

Code Style

This project uses several tools to maintain code quality:

ESLint

  • Run linting: pnpm lint
  • Auto-fix issues: pnpm lint:fix

Prettier

  • Check formatting: pnpm format:check
  • Format code: pnpm format

TypeScript

  • Type check all packages: pnpm ts:check

Pre-commit Hooks

The project uses Husky and lint-staged to automatically:

  • Run ESLint on staged JavaScript/TypeScript/JSON/Markdown files
  • Format all staged files with Prettier
  • Type check all packages

Commit Guidelines

This project follows Conventional Commits specification.

Commit Types

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • chore: Changes to the build process or auxiliary tools

Examples

feat: add volume mount support to Docker deployer
fix: resolve processFullName ternary logic in K8s deployer
docs: update README with installation instructions
refactor: extract health check mapping to shared utility

Using Commitizen

To ensure proper commit format, use:

pnpm commit

Pull Request Process

  1. Create a feature branch

    git checkout -b feature/your-feature-name

  2. Make your changes

    • Follow the code style guidelines
    • Add tests if applicable
    • Update documentation as needed

  3. Verify your changes

    pnpm lint
pnpm format:check
pnpm ts:check
pnpm test
pnpm build

  4. Commit your changes

    pnpm commit

  5. Push to your fork

    git push origin feature/your-feature-name

  6. Create a Pull Request

    • Provide a clear description of the changes
    • Reference any related issues
    • Ensure all CI checks pass

Changesets

This project uses Changesets for version management. If your PR changes any published package, add a changeset:

pnpm changeset

Follow the prompts to select affected packages and describe the change. The changeset file will be committed with your PR.

Reporting Issues

When reporting issues, please include:

  • Description: Clear and concise description of the problem
  • Steps to reproduce: Detailed steps to reproduce the issue
  • Expected behavior: What you expected to happen
  • Actual behavior: What actually happened
  • Environment: OS, Node.js version, pnpm version
  • Additional context: Any other relevant information

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.