Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (35 loc) · 976 Bytes

CONTRIBUTING.md

File metadata and controls

48 lines (35 loc) · 976 Bytes
Raw

Contributing to php-datapack

Thank you for considering contributing! Here's how to get started.

Setup

git clone https://github.com/kexxt/datapack.git
cd datapack
composer install

Development Workflow

  1. Create a feature branch from main
  2. Write your code with tests
  3. Run the quality checks:
composer test      # Pest tests
composer analyse   # PHPStan level 8
composer lint      # Code style check
composer fix       # Auto-fix code style
  1. All three must pass before submitting a PR

Code Standards

  • PHP 8.2+ with declare(strict_types=1) in every file
  • PER-CS 2.0 coding standard
  • PHPStan level 8 with no baseline
  • Every public feature needs a test

Pull Requests

  • Keep PRs focused on a single change
  • Write a clear description of what and why
  • Reference any related issues
  • Ensure CI passes

Reporting Issues

Open an issue with:

  • What you expected
  • What happened
  • Steps to reproduce
  • PHP version and OS