Skip to content

Latest commit

 

History

History
49 lines (37 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

49 lines (37 loc) · 1.76 KB
Raw

Contributing

When contributing to this service, please open an issue via the GitHub issues page or send a mail to [email protected] before making a change.

Bugs

Bugs must be reported via the GitHub issues page.

Bug fixes and improvements can be provided via a Pull Request.

A fix that introduces a change in behavior is considered a breaking change.

Features

Features and Breaking Changes must be discussed with the maintainers of this repository.

A feature that introduces a change in existing behavior is considered a breaking change.

Breaking Changes

A breaking change must be discussed with the maintainers. The list of maintainers can be found here

Pull Request Process

  • Update the README.md with details of changes to the interface, classes or general behaviour.
  • Contact one of the maintainers in the Pull Request. The list of maintainers can be found here
  • Every Pull Request with actual code changes has to add or adapt unit tests.
  • Create a meaningful title for the Pull Request that addresses the topic.
  • The Pull Request must pass the CI integration. Be aware of the currently supported PHP versions and optimize your code according to the supported versions.
  • Keep the Pull Request as small as possible. Avoid unnecessary changes to speed up the review process.
  • Write readable and understandable code. Try always to create the best possible solution.
  • Use readable and understandable commit messages, so the reviewer can understand the intention of each commit.