Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

68 lines (45 loc) · 1.19 KB

Contributing

Thank you for your interest in contributing to @echecs/pgn.

Prerequisites

Setup

git clone git@github.com:mormubis/pgn.git
cd pgn
pnpm install

Development Workflow

Running tests

pnpm test

Watch mode during development:

pnpm test:watch

Linting and formatting

pnpm lint
pnpm format

Building

pnpm build

Submitting Changes

  1. Fork the repository and create a branch from main.
  2. Make your changes, including tests for any new behaviour.
  3. Ensure all checks pass: pnpm lint && pnpm test && pnpm build.
  4. Open a pull request describing what you changed and why.

Reporting Bugs

Open an issue at https://github.com/mormubis/pgn/issues and include:

  • A minimal reproducible example
  • Expected vs. actual behaviour
  • Your Node.js and package version

Commit Style

Keep commits focused and use clear messages. No specific convention is enforced, but describe the why, not just the what.

License

By contributing you agree that your contributions will be licensed under the MIT License.