Skip to content

Latest commit

 

History

History
45 lines (40 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

45 lines (40 loc) · 2.71 KB
Raw

Contributing

Contributions are welcome. We accept pull requests on GitHub.

Workflow

If you have an idea for a new feature, it's a good idea to check out our issues or active pull requests first to see if the feature is already being worked on. If not, feel free to submit an issue first, asking whether the feature is beneficial to the project. This will save you from doing a lot of development work only to have your feature rejected. We don't enjoy rejecting your hard work, but some features just don't fit with the goals of the project.

When you do begin working on your feature, here are some guidelines to consider:

  • Your pull request description should clearly detail the changes you have made.
  • Please write tests for any new features you add.
  • Please ensure that tests pass before submitting your pull request.
  • Use topic/feature branches. Please do not ask us to pull from your master branch.
  • Submit one feature per pull request. If you have multiple features you wish to submit, please break them up into separate pull requests.
  • Send coherent history. Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Coding Guidelines

This project comes with a configuration file and an executable for php-cs-fixer (.php_cs.dist) that you can use to (re)format your source code for compliance with this project's coding guidelines:

composer cs-fix

For a simple check of the code standard, there is a command:

composer cs-check

Static analysis

To improve the quality of the code used static analysis (via psalm and phpstan). You can start it with the command:

composer psalm && composer phpstan

Running the tests

The following tests must pass before we will accept a pull request. If any of these do not pass, it will result in a complete build failure.

composer tests

Communication Channels

You can find help and discussion in the following places:

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Reporting issues