Skip to content

Latest commit

 

History

History
86 lines (52 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

86 lines (52 loc) · 3.27 KB
Raw

Contributing to sebastian/code-unit

Welcome!

We look forward to your contributions! Here are some examples how you can contribute:

Please do not send pull requests that expand the scope of this project (see below).

Any contributions you make will be under the BSD-3-Clause License

When you submit code changes, your submissions are understood to be under the same BSD-3-Clause License that covers the project. By contributing to this project, you agree that your contributions will be licensed under its BSD-3-Clause License.

Write bug reports with detail, background, and sample code

This is an example of a bug report I wrote, and I think it's not too bad.

In your bug report, please provide the following:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Please post code and output as text (using proper markup). Do not post screenshots of code or output.

Workflow for Pull Requests

  1. Fork the repository.
  2. Create your branch from the oldest branch that is affected by the bug you plan to fix.
  3. Implement your change and add tests for it.
  4. Ensure the test suite passes.
  5. Ensure the code complies with our coding guidelines (see below).
  6. Send that pull request!

Please make sure you have set up your username and email address for use with Git. Strings such as silly nick name <root@localhost> look really stupid in the commit history of a project.

We encourage you to sign your Git commits with your GPG key.

Development

This project uses PHPUnit for testing:

./vendor/bin/phpunit

This project uses PHPStan for static analysis:

./tools/phpstan

This project uses PHP-CS-Fixer to enforce coding guidelines:

./tools/php-cs-fixer fix

The commands shown above require an autoloader script at vendor/autoload.php. This can be generated like so:

./tools/composer dump-autoload

Please understand that we will not accept a pull request when its changes violate this project's coding guidelines or break the test suite.

Low Maintenance Project

This library was developed specifically as a dependency for PHPUnit. Starting with PHPUnit 12, PHPUnit no longer depends on this library.

This library is now a low maintenance project. Bugs that have an impact on versions of PHPUnit that still receive bug fixes and still depend on this library will be fixed in this library.

Aside from the above, no further development of this library is planned.