Skip to content

Latest commit

 

History

History
85 lines (55 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

85 lines (55 loc) · 3.52 KB
Raw

Contributing

Contributions are welcome and will be fully credited.

Please read and understand the contribution guide before creating an issue or pull request.

Etiquette

This project is open source, and as such, the maintainers give their free time to build and maintain the source code held within. They make the code freely available in the hope that it will be of use to other developers. It would be extremely unfair for them to suffer abuse or anger for their hard work.

Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the world that developers are civilized and selfless people.

It's the duty of the maintainer to ensure that all submissions to the project are of sufficient quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.

Viability

When requesting or submitting new features, first consider whether it might be useful to others. Open source projects are used by many developers, who may have entirely different needs to your own. Think about whether or not your feature is likely to be used by other users of the project.

Procedure

Before filing an issue:

  • Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
  • Check to make sure your feature suggestion isn't already present within the project.
  • Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
  • Check the pull requests tab to ensure that the feature isn't already in progress.

Before submitting a pull request:

  • Check the codebase to ensure that your feature doesn't already exist.
  • Check the pull requests to ensure that another person hasn't already submitted the feature or fix.

Run Tests

The full test suite requires PHP cli with mongodb extension and a running MongoDB server. A replica set is required for testing transactions. Duplicate the phpunit.xml.dist file to phpunit.xml and edit the environment variables to match your setup.

$ docker-compose run app

Docker can be slow to start. You can run the command composer run test locally or in a docker container.

$ docker-compose run -it tests bash
# Inside the container
$ composer install
$ composer run test

For fixing style issues, you can run the PHP Code Beautifier and Fixer, some issues can't be fixed automatically:

$ composer run cs:fix
$ composer run cs

Requirements

If the project maintainer has any additional requirements, you will find them listed here.

  • PSR-2 Coding Standard - The easiest way to apply the conventions is to install PHP Code Sniffer.

  • Add tests! - Your patch won't be accepted if it doesn't have tests.

  • Document any change in behaviour - Make sure the documentation is kept up-to-date, and update the changelog for new features and bug fixes.

  • Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.

Happy coding!

Releasing

The releases are created by the maintainers of the library. The process is documented in the RELEASING.md file.