Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

28 lines (18 loc) · 1.22 KB

Contributing to remorhaz/int-rangeset

Keep a changelog

Please don't forget to update CHANGELOG.md when you're making some changes users should know about.

Static checks

Code style

Code style should conform to PSR-12 standard with the following exceptions:

  • Test method names must follow testMethod_Conditions_Behaviour pattern.

Run composer test-cs to check the code style.

Psalm

Psalm is static analysis tool for finding errors in PHP applications. You can learn more about it in its documentation. Code of this library must conform to level 1 of Psalm checks (the strictest one).

Run composer test-psalm to run Psalm checks on code.

Dynamic checks

Unit tests

Please don't forget to write and update unit tests using PHPUnit framework. Please keep coverage as high as possible.

Run composer test-unit to run unit tests, or composer test to run all static and dynamic checks altogether.

Infection

Infection is a mutation testing framework that helps to keep quality of unit tests high.

Run composer infection to run Infection checks on code.