Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (47 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

67 lines (47 loc) · 1.2 KB

CONTRIBUTING

Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.

Process

  1. Fork the project
  2. Create a new branch
  3. Code, test, commit and push
  4. Open a pull request detailing your changes.

Guidelines

  • Please ensure the coding style running composer lint.
  • Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
  • You may need to rebase to avoid merge conflicts.

1. Package Development

Setup

Clone your fork, then install the dev dependencies:

composer install

Code Quality Tests

To run all of the below checks with one command, run:

composer test:all

Formatting

Format your code:

composer format

Tests

Run the test suite:

composer test

Static Analysis

Run PHPStan:

composer analyze

2. Documentation

The documentation is built using Vitepress and located in /docs.

We use pnpm for package management.

To run the site locally, run:

cd docs
pnpm i
pnpm docs:dev