|
| 1 | +# How to contribute |
| 2 | + |
| 3 | +We are really glad you're reading this, because we need volunteer developers to |
| 4 | +help this project come to fruition. |
| 5 | + |
| 6 | +If you haven't already, come find us in IRC (#contao.mm on freenode). |
| 7 | +We want you working on things you're excited about. |
| 8 | + |
| 9 | +The following is a set of guidelines for contributing to MetaModels and its |
| 10 | +packages, which are hosted in the [MetaModels organization][1] on GitHub. These |
| 11 | +are just guidelines, not rules, use your best judgement and feel free to |
| 12 | +propose changes to this document in a pull request. |
| 13 | + |
| 14 | +## Submitting issues |
| 15 | + |
| 16 | +* Use the search function to see if a similar issue has already been submitted. |
| 17 | +* Describe the issue in detail and include all the steps to follow in order to |
| 18 | + reproduce the bug. |
| 19 | +* Include the version of Contao, PHP and MetaModels you are using (if possible |
| 20 | + with a detailed list of other installed extensions that might be related). |
| 21 | +* Include screenshots or screencasts if possible; they are immensely helpful. |
| 22 | +* If you are reporting a bug, please include any related error message you are |
| 23 | + seeing and also check the `system/logs/error.log` file. The error message is |
| 24 | + not just the message but also the complete(!) stack trace below the message. |
| 25 | + This trace is a long list of function calls which helps us to diagnose the |
| 26 | + problem en detail. |
| 27 | + |
| 28 | +## Submitting changes |
| 29 | + |
| 30 | +* Please send a [GitHub Pull Request to MetaModels][1] with a clear list of what |
| 31 | + you've done (read more about [pull requests][2]). |
| 32 | +* When you send a pull request, we will love you forever if you include |
| 33 | + phpunit tests. We can always use more test coverage. |
| 34 | +* Please follow the [phpcq 2.0][3] coding standards. |
| 35 | +* Please make sure all of your commits are atomic (only one feature or fix per |
| 36 | + commit). |
| 37 | +* We use phpcq/all-tasks in these projects, so please check your changes |
| 38 | + using phpcq when submitting a pull request. |
| 39 | +* Create your pull request against the [`master`][4] branch for bug fixes or the |
| 40 | + [`develop`][5] branch for new features. |
| 41 | +* Include screenshots in your pull request whenever possible. |
| 42 | + |
| 43 | +Always write a clear log message for your commits. |
| 44 | +One-line messages are fine for small changes, but bigger changes should look |
| 45 | +like this: |
| 46 | + |
| 47 | + $ git commit -m "A brief summary of the commit |
| 48 | + > |
| 49 | + > A paragraph describing what changed and its impact." |
| 50 | + |
| 51 | +## Testing |
| 52 | + |
| 53 | +We have a handful of unit tests. Please write unit tests for new code you |
| 54 | +create. |
| 55 | + |
| 56 | +## Git commit messages |
| 57 | + |
| 58 | +* Use the present tense ("Add feature" not "Added feature"). |
| 59 | +* Use the imperative mood ("Move cursor to …" not "Moves cursor to …"). |
| 60 | +* Reference issues and pull requests liberally. |
| 61 | + |
| 62 | +[1]: https://github.com/MetaModels |
| 63 | +[2]: http://help.github.com/pull-requests/ |
| 64 | +[3]: https://github.com/phpcq/coding-standard |
| 65 | +[4]: https://github.com/MetaModels/filter_checkbox/pull/new/master |
| 66 | +[5]: https://github.com/MetaModels/filter_checkbox/pull/new/develop |
0 commit comments