| commit | author | age | ||
| 2207d6 | 1 | Contributing |
| W | 2 | ------------ |
| 3 | ||
| 4 | Gherkin is an open source, community-driven project. If you'd like to contribute, feel free to do this, but remember to follow this few simple rules: | |
| 5 | ||
| 6 | - Make your feature addition or bug fix, | |
| 7 | - Always use the `master` branch as base for your changes (all new development happens in `master`), | |
| 8 | - Add tests for those changes (please look into `tests/` folder for some examples). This is important so we don't break it in a future version unintentionally, | |
| 9 | - Commit your code, but do not mess with `CHANGES.md`, | |
| 10 | - __Remember__: when you create Pull Request, always select `master` branch as target (done by default), otherwise it will be closed. | |
| 11 | ||
| 12 | Running tests | |
| 13 | ------------- | |
| 14 | ||
| 15 | Make sure that you don't break anything with your changes by running: | |
| 16 | ||
| 17 | ```bash | |
| 18 | $> phpunit | |
| 19 | ``` | |
| 20 | ||
| 21 | Contributing to Gherkin Translations | |
| 22 | ------------------------------------ | |
| 23 | ||
| 24 | Gherkin supports →40 different languages and you could add more! You might notice | |
| 25 | `i18n.php` file in the root of the library. This file is downloaded and **autogenerated** | |
| 26 | from original [cucumber/gherkin translations](https://github.com/cucumber/cucumber/blob/master/gherkin/gherkin-languages.json). | |
| 27 | So, in order to fix/update/add some translation, you should send Pull Request to the | |
| 28 | `cucumber/gherkin` repository. `Behat\Gherkin` will redownload/regenerate translations | |
| 29 | from there before each release. | |
| 30 | ||
| 31 | It might sounds difficult, but this way of dictionary sharing gives you ability to | |
| 32 | migrate your `*.feature` files from language to language and library to library without | |
| 33 | the need to rewrite/modify them - same dictionary (Gherkin) used everywhere. | |
