Skip to content

Latest commit

 

History

History
51 lines (30 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

51 lines (30 loc) · 1.69 KB
Raw

Submitting issues

Please read the below before posting an issue. Thank you!

  • If your question is about the Pricehubble API itself, please check out the Pricehubble Doc. This project doesn't handle any of that logic - we're just helping you form the requests.

If, however, you think you've found a bug, or would like to discuss a change or improvement, feel free to raise an issue and we'll figure it out between us.

Pull requests

This is a fairly simple wrapper, but it has been made much better by contributions from those using it. If you'd like to suggest an improvement, please raise an issue to discuss it before making your pull request.

Pull requests for bugs are more than welcome - please explain the bug you're trying to fix in the message.

There are a small number of PHPUnit unit tests. Unit testing against an API is obviously a bit tricky, but I'd welcome any contributions to this. It would be great to have more test coverage.

Developing

🚔 Check Symfony 4 coding standards & best practices

You need to run composer before using FriendsOfPHP/PHP-CS-Fixer.

Command Line Usage

Check & Fix Symfony 4 coding standards:

./vendor/bin/php-cs-fixer fix -v --dry-run --using-cache=no

Automatically fix coding standards

./vendor/bin/php-cs-fixer fix -v --using-cache=no

Improve global code quality using PHPCPD (Code duplication)

Copy/Paste Detector

./vendor/bin/phpcpd ./web/modules/custom

Enforce code standards with git hooks

Maintaining code quality by adding the custom post-commit hook to yours.

cat ./bin/post-commit >> ./.git/hooks/post-commit