Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

40 lines (29 loc) · 2.27 KB
Raw

Filing bug reports

Bugs or feature requests can be posted online on the GitHub issues section of the project.

When reporting bugs, in addition to the obvious description of your issue you must always provide some essential information about your environment such as:

  1. version of Predis (check the VERSION file or the Predis\Client::VERSION constant).
  2. version of Redis (check the redis_version field returned by INFO).
  3. version of PHP.
  4. name and version of the operating system.
  5. when possible, a small snippet of code that reproduces the issue.

Think about it: we do not have a crystal ball and cannot predict things and peer into the unknown, so please provide as much details as possible to help us isolating issues and fix them.

Never use GitHub issues to post generic questions about Predis! When you have questions about how Predis works or how it can be used, please just hop me an email and I will get back to you as soon as possible.

Contributing code

If you want to work on Predis, it is highly recommended that you first run the test suite in order to check that everything is OK, and report strange behaviours or bugs. When modifying Predis please make sure that no warnings or notices are emitted by PHP by running the interpreter in your development environment with the error_reporting variable set to E_ALL | E_STRICT.

The recommended way to contribute to Predis is to fork the project on GitHub, create new topic branches on your newly created repository to fix or add features (possibly with tests covering your modifications) and then open a new pull request with a description of the applied changes. Obviously you can use any other Git hosting provider of your preference.

When writing code please follow the basic coding (PSR-1) and coding style (PSR-2) standards and stick with the conventions used in Predis to name classes and interfaces.

Please also follow some basic commit guidelines before opening pull requests.