Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 1.46 KB
Raw

How to contribute

Issues

When filing bugs, try to be as thorough as possible:

  • What version did you use?
  • What did you try to do? Please post the relevant parts of your code.
  • What went wrong? Please include error messages, if any.
  • What was the expected result?

Pull requests

Bug fixes and general improvements to the existing codebase are always welcome. New features are also welcome, but will be judged on an individual basis. If you'd rather not risk wasting your time implementing a new feature only to see it turned down, please start the discussion by opening an issue.

Testing

Please include tests for every change or addition to the code. To run the complete test suite:

make test

GitHub Actions have been configured to run supported PHP versions. Upon submitting a new pull request, that test suite will be run & report back on your pull request. Please make sure the test suite passes.

Coding standards

All code must follow PSR-12. Just make sure to run php-cs-fixer before submitting the code, it'll take care of the formatting for you:

make format

Document the code thoroughly!

License

Note that path-converter is MIT-licensed, which basically allows anyone to do anything they like with it, without restriction.