|
| 1 | +# Contributing |
| 2 | + |
| 3 | +You are very welcome to contribute to this project by giving constructive criticism, feedback, creating issues and |
| 4 | +submitting pull requests. |
| 5 | + |
| 6 | +Each contribution is appreciated. |
| 7 | + |
| 8 | +## Areas of Focus |
| 9 | + |
| 10 | +Every aspect of this project from documentation to actual code is subject for improvement. |
| 11 | + |
| 12 | +However, due to the security aspect we would like to strongly encourage reviews of the implementations of the |
| 13 | +encryption and decryption processes. This also includes the choice of supported ciphers and modes. |
| 14 | + |
| 15 | +## Bug Reports |
| 16 | + |
| 17 | +Bugs may be reported in the project issue tracker. |
| 18 | + |
| 19 | +Bug reports should include information on |
| 20 | + |
| 21 | +* the version of the Symfony framework |
| 22 | +* the version of the ParameterEncryptionBundle |
| 23 | +* the version of a potentially affected add-on bundle (like ParameterEncryptionDefuseBundle) |
| 24 | +* instructions on how to reproduce the problem |
| 25 | +* the expected behavior |
| 26 | +* the actual behavior |
| 27 | + |
| 28 | +We may also ask for sample code in a fresh project based on the |
| 29 | +[Symfony Standard Edition](https://github.com/symfony/symfony-standard) if we cannot simulate it otherwise. |
| 30 | +Ideally, this would be as easy as cloning a repository and following a couple of steps. |
| 31 | + |
| 32 | +## Contributing Code |
| 33 | + |
| 34 | +Please make sure that the documentation is still up to date and not missing any vital information relating to your |
| 35 | +changes! |
| 36 | + |
| 37 | +### Before Submitting a Pull Request |
| 38 | + |
| 39 | +In order to maintain a certain quality level for the code, this project is using several tools to help with testing and |
| 40 | +coding standards. |
| 41 | + |
| 42 | +The following steps are required: |
| 43 | + |
| 44 | +* All tests have to execute successfully. |
| 45 | + |
| 46 | +* Check the code coverage in order to stay at 100%: |
| 47 | + |
| 48 | + ```console |
| 49 | + $ ./vendor/bin/phpunit -v --coverage-text |
| 50 | + ``` |
| 51 | + |
| 52 | +* Run PHP CS Fixer for coding standards / code style: |
| 53 | + |
| 54 | + ```console |
| 55 | + $ ./vendor/bin/php-cs-fixer fix -v --dry-run --diff . |
| 56 | + ``` |
| 57 | + |
| 58 | +Automated versions of these checks will run during the build process. |
| 59 | + |
| 60 | +Any errors will make the build fail. |
| 61 | + |
| 62 | +You can find links to the results of the build process and the code coverage at the top of the [README](README.md). |
0 commit comments