Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 3.47 KB

README.md

File metadata and controls

66 lines (42 loc) · 3.47 KB
Raw

The Test Tools library

Package version contributions welcome License PHP PHP PHP

This bundle is a shortcut to install the whole RichCongress test suite for Symfony. It requires PHP 8.1+ and Symfony 6 or Symfony 7.

Quick showcase

A great drawing is always better than a long speech.

Test Suite Schema

Table of content

  1. Installation
  2. Versioning
  3. Contributing
  4. License

1. Installation

composer require richcongress/test-suite

Then, please check the documentation of the various libraries:

2. Versioning

test-suite follows semantic versioning. In short the scheme is MAJOR.MINOR.PATCH where

  1. MAJOR is bumped when there is a breaking change,
  2. MINOR is bumped when a new feature is added in a backward-compatible way,
  3. PATCH is bumped when a bug is fixed in a backward-compatible way.

Versions bellow 1.0.0 are considered experimental and breaking changes may occur at any time.

3. Contributing

Contributions are welcomed! There are many ways to contribute, and we appreciate all of them. Here are some of the major ones:

  • Bug Reports: While we strive for quality software, bugs can happen and we can't fix issues we're not aware of. So please report even if you're not sure about it or just want to ask a question. If anything the issue might indicate that the documentation can still be improved!
  • Feature Request: You have a use case not covered by the current api? Want to suggest a change or add something? We'd be glad to read about it and start a discussion to try to find the best possible solution.
  • Pull Request: Want to contribute code or documentation? We'd love that! If you need help to get started, GitHub as documentation on pull requests. We use the "fork and pull model" were contributors push changes to their personnal fork and then create pull requests to the main repository. Please make your pull requests against the master branch.

As a reminder, all contributors are expected to follow our Code of Conduct.

4. License

test-suite is distributed under the terms of the MIT license.

See LICENSE for details.