Skip to content

Latest commit

 

History

History
101 lines (61 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

101 lines (61 loc) · 1.75 KB

Contributing to GotenbergBundle

Thank you for your interest in contributing to GotenbergBundle!

Your support helps make this project better for everyone.

How to Contribute

Report Issues

Found a bug or have a feature request? Open an issue to let us know.

Submit Pull Requests

  • Fork the repository.
  • Create a new branch for your changes.
  • Ensure your code follows the existing style and includes tests if applicable.
  • Submit a pull request with a clear description of your changes.

Installation

To set up the project locally for development:

Clone the Repository

git clone https://github.com/sensiolabs/GotenbergBundle.git
cd GotenbergBundle

Install Dependencies

composer install

Testing

Ensure your changes work as expected by running the test suite:

Run Tests

./vendor/bin/phpunit

Run Tests with Coverage (optional)

./vendor/bin/phpunit --coverage-text

Quality Assurance

Maintain high code quality by following these steps before submitting a pull request:

Code Linting

Check your code for style violations:

./vendor/bin/php-cs-fixer check --diff

Eventually, you can fix the issues automatically:

./vendor/bin/php-cs-fixer fix --diff

Static Analysis

./vendor/bin/phpstan analyse

Detect potential issues in your code.

Fix Issues

Address any warnings or errors reported by the tools above.

Documentation

The project documentation is partially built from the source code.

Important

When you make changes to the codebase, update the documentation accordingly.

Update the documentation

php ./docs/generate.php

Thank you for contributing to GotenbergBundle!