Skip to content

Latest commit

 

History

History
121 lines (72 loc) · 5.37 KB

CONTRIBUTING.md

File metadata and controls

121 lines (72 loc) · 5.37 KB
Raw

Contributing to PHPUnit

Welcome!

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

We have a Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

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 do not report a bug for a version of PHPUnit that is no longer supported. Please do not report a bug if you are using a version of PHP that is not supported by the version of PHPUnit you are using.

Please do not report an issue if you are not using PHPUnit directly, but rather a third-party wrapper around it.

Please do not report an issue if you are using a third-party extension such as alternative output printers.

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

Please include the output of composer info | sort if you installed PHPUnit using Composer.

Please use the most specific issue tracker to search for existing tickets and to open new tickets:

Workflow for Pull Requests

  1. Fork the repository.
  2. Create your branch from main if you plan to implement new functionality or change existing code significantly; create your branch from the oldest branch that is affected by the bug if you plan to fix a bug.
  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.

Pull requests for bug fixes must be made for the oldest branch that is supported. Pull requests for new features must be based on the main branch.

We are trying to keep backwards compatibility breaks in PHPUnit to an absolute minimum. Please take this into account when proposing changes.

Due to time constraints, we are not always able to respond as quickly as we would like. Please do not take delays personal and feel free to remind us if you feel that we forgot to respond.

Coding Guidelines

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

$ ./tools/php-cs-fixer fix

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

Static Analysis

This project comes with a configuration file (located at /phpstan.neon in the repository) and an executable for PHPStan (located at /tools/phpstan in the repository) that you can use to perform static analysis:

$ ./tools/phpstan

Using PHPUnit from a Git checkout

The following commands can be used to perform the initial checkout of PHPUnit:

$ git clone git:https://github.com/sebastianbergmann/phpunit.git

$ cd phpunit

Install PHPUnit's dependencies using Composer:

$ ./tools/composer install

The phpunit script can be used to invoke the PHPUnit test runner:

$ ./phpunit --version

Running PHPUnit's own test suite

After following the steps shown above, PHPUnit's own test suite is run like this:

$ ./phpunit