www.aleph1.co.uk Git - yaffs-website/blob - vendor/behat/behat/README.md

   1 ![Behat](https://github.com/Behat/logo/raw/master/logo.png)
   2
   3 Behat is a BDD framework for PHP to help you test business expectations.
   4
   5 [![Gitter chat](https://badges.gitter.im/Behat/Behat.svg)](https://gitter.im/Behat/Behat)
   6 [![License](https://poser.pugx.org/behat/behat/license.svg)](https://packagist.org/packages/behat/behat)
   7 [![Unix Status](https://travis-ci.org/Behat/Behat.svg?branch=master)](https://travis-ci.org/Behat/Behat)
   8 [![Windows status](https://ci.appveyor.com/api/projects/status/9uc5sellmvbv02ei/branch/master?svg=true)](https://ci.appveyor.com/project/everzet/behat/branch/master)
   9 [![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/Behat/Behat/badges/quality-score.png?s=ad84e95fc2405712f88a96d89b4f31dfe5c80fae)](https://scrutinizer-ci.com/g/Behat/Behat/)
  10
  11 Installing Behat
  12 ----------------
  13
  14 The easiest way to install Behat is by using [Composer](https://getcomposer.org):
  15
  16 ```bash
  17 $> curl -sS https://getcomposer.org/installer | php
  18 $> php composer.phar require behat/behat
  19 ```
  20
  21 After that you'll be able to run Behat via:
  22
  23 ```bash
  24 $> vendor/bin/behat
  25 ```
  26
  27 Installing Development Version
  28 ------------------------------
  29
  30 Clone the repository and install dependencies via [Composer](https://getcomposer.org):
  31
  32 ```bash
  33 $> curl -sS https://getcomposer.org/installer | php
  34 $> php composer.phar install
  35 ```
  36
  37 After that you will be able to run development version of Behat via:
  38
  39 ```bash
  40 $> bin/behat
  41 ```
  42
  43 Contributing
  44 ------------
  45
  46 Before contributing to Behat, please take a look at the [CONTRIBUTING.md](CONTRIBUTING.md) document.
  47
  48 Versioning
  49 ----------
  50
  51 Starting from `v3.0.0`, Behat is following [Semantic Versioning v2.0.0](http://semver.org/spec/v2.0.0.html).
  52 This basically means that if all you do is implement interfaces (like [this one](https://github.com/Behat/Behat/blob/v3.1.0/src/Behat/Behat/Context/ContextClass/ClassResolver.php#L15-L22))
  53 and use service constants (like [this one](https://github.com/Behat/Behat/blob/v3.1.0/src/Behat/Behat/Context/ServiceContainer/ContextExtension.php#L46)),
  54 you would not have any backwards compatibility issues with Behat up until `v4.0.0` (or later major)
  55 is released. Exception could be an extremely rare case where BC break is introduced as a measure
  56 to fix a serious issue.
  57
  58 You can read detailed guidance on what BC means in [Symfony2 BC guide](http://symfony.com/doc/current/contributing/code/bc.html).
  59
  60 Useful Links
  61 ------------
  62
  63 - The main website is at [http://behat.org](http://behat.org)
  64 - The documentation is at [http://docs.behat.org/en/latest/](http://docs.behat.org/en/latest/)
  65 - Official Google Group is at [http://groups.google.com/group/behat](http://groups.google.com/group/behat)
  66 - IRC channel on [#freenode](http://freenode.net/) is `#behat`
  67 - [Note on Patches/Pull Requests](CONTRIBUTING.md)
  68
  69 Contributors
  70 ------------
  71
  72 - Konstantin Kudryashov [everzet](http://github.com/everzet) [lead developer]
  73 - Other [awesome developers](https://github.com/Behat/Behat/graphs/contributors)