Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
20 lines (12 loc) · 993 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (12 loc) · 993 Bytes
Raw

Contributing to AddonPay

Thank you for contributing to AddonPay.

Workflow

  1. Create a branch from main.
  2. Install dependencies with pnpm install.
  3. Make one coherent change and use a Conventional Commit message.
  4. Run pnpm format:check and pnpm check before opening a pull request to main.

Commits and releases

Commit messages follow Conventional Commits. feat triggers a minor package release and fix triggers a patch release. Before 1.0.0, a breaking change also triggers a minor release; after 1.0.0, it triggers a major release. Nx Release creates versions, tags, GitHub Releases, and npm publications after merges to main.

Do not manually edit package versions, create release tags, or publish packages after the initial bootstrap.

Pull requests

Keep pull requests focused, explain the user-facing change, and link relevant issues. CI validates formatting, commit messages, and package tarballs.