Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (46 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

64 lines (46 loc) · 1.17 KB
Raw

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.
  • Please remember that we follow SemVer.

1. Package Development

Setup

Clone your fork, then install the dev dependencies:

composer install

Build workbench:

composer build

Playground

You can visit a test application via Workbench:

composer serve

Lint

Lint your code:

composer lint

Tests

Run all tests:

composer test

2. Documentation

The documentation is built using Vitepress.

To run the site locally, run:

cd docs
npm i
npm run dev