|
| 1 | +# How to contribute |
| 2 | + |
| 3 | +There are several ways to help out: |
| 4 | + |
| 5 | +* Create an issue on GitHub, if you have found a bug |
| 6 | +* Write test cases for open bug issues |
| 7 | +* Write fixes for open bug/feature issues, preferably with test cases included |
| 8 | +* Contribute to the [documentation](https://github.com/LeanMapper/LeanMapper.github.io) or [examples](https://github.com/LeanMapper/examples) |
| 9 | + |
| 10 | + |
| 11 | +## Issues |
| 12 | + |
| 13 | +A good bug report shouldn't leave others needing to chase you up for more |
| 14 | +information. Please try to be as detailed as possible in your report. |
| 15 | + |
| 16 | +**Feature requests** are welcome. But take a moment to find out whether your idea |
| 17 | +fits with the scope and aims of the project. It's up to *you* to make a strong |
| 18 | +case to convince the project's developers of the merits of this feature. |
| 19 | + |
| 20 | + |
| 21 | +## Contributing |
| 22 | + |
| 23 | +### Preparing environment |
| 24 | + |
| 25 | +Start with [forking](https://help.github.com/articles/fork-a-repo) [Lean Mapper on GitHub](https://github.com/Tharos/LeanMapper). |
| 26 | +Carefully [set up](https://help.github.com/articles/set-up-git) your local Git environment, configure your username and email, these credentials will identify your changes in Lean Mapper history. |
| 27 | + |
| 28 | + |
| 29 | +### Working on your patch |
| 30 | + |
| 31 | +Before you start working on your patch, create a new branch for your changes. |
| 32 | + |
| 33 | +``` |
| 34 | +git checkout -b new_branch_name |
| 35 | +``` |
| 36 | + |
| 37 | + |
| 38 | +### Testing your changes |
| 39 | + |
| 40 | +You need to install [Nette Tester](https://tester.nette.org/). The easiest way is to call `composer install` in repository root. |
| 41 | + |
| 42 | +Now you should be able to run tests. On unix-like systems run following command in your terminal: |
| 43 | + |
| 44 | +``` |
| 45 | +`vendor/bin/tester` -p php -c tests/php-unix.ini |
| 46 | +``` |
| 47 | + |
| 48 | +**Note:** the tests require these PHP extensions: |
| 49 | + |
| 50 | +* `json` |
| 51 | +* `sqlite3` |
| 52 | +* `tokenizer` |
| 53 | + |
| 54 | +---- |
| 55 | + |
| 56 | +Please do not fix whitespace, format code, or make a purely cosmetic patch. |
| 57 | + |
| 58 | +Thanks! |
0 commit comments