|
| 1 | +Contribution Guidelines |
| 2 | +======================= |
| 3 | + |
| 4 | +Thank you for considering contributing to this bundle. We welcome any kind of |
| 5 | +contribution, no matter if its huge or small, about documentation or code. We |
| 6 | +also welcome any kind of developers, from experts to people who just started |
| 7 | +working on Open-Source projects. |
| 8 | + |
| 9 | +Requirements |
| 10 | +------------ |
| 11 | + |
| 12 | +Before your first contribution, make sure you'll meet these requirements: |
| 13 | + |
| 14 | + * You have a user account on [GitHub](https://github.com/). |
| 15 | + * You have installed in your computer a working environment to develop PHP |
| 16 | + applications. |
| 17 | + * You have a basic level of English (code, docs and discussions are in English). |
| 18 | + |
| 19 | +All submitted contributions (both code and documentation) adhere implicitly to |
| 20 | +the [Open-Source MIT License][mit-license]. |
| 21 | + |
| 22 | +Proposing New Features |
| 23 | +---------------------- |
| 24 | + |
| 25 | +We are determined to maintain the original simple and pragmatic philosophy of |
| 26 | +the bundle. This means that we routinely reject any feature that complicates the |
| 27 | +code too much or which doesn't fit in the bundle's philosophy. |
| 28 | + |
| 29 | +That's why **we strongly recommend you** to propose new features by |
| 30 | +[opening a new issue][create-issue] in the repository to discuss about them |
| 31 | +instead of submitting a pull request with the code of the proposed feature. |
| 32 | + |
| 33 | +Reporting Bugs |
| 34 | +-------------- |
| 35 | + |
| 36 | + 1. Go to [the list of AdminThemeBundle issues][adminthemebundle-issues] and look for any |
| 37 | + existing bug similar to yours. |
| 38 | + 2. If the bug hasn't been reported yet, [create a new issue][create-issue] and |
| 39 | + fill in the given issue template. |
| 40 | + |
| 41 | +Sending Pull Requests |
| 42 | +--------------------- |
| 43 | + |
| 44 | +This project follows the same contribution workflow used by the Symfony project. |
| 45 | +First you must clone the repository, then create a feature branch and finally, |
| 46 | +submit a pull request via GitHub. |
| 47 | + |
| 48 | +Read the [Symfony contribution guide][sf-contribution] for more details and replace |
| 49 | +`symfony/symfony-docs` by `avanzu/AdminThemeBundle` in every example. |
| 50 | + |
| 51 | +Further information |
| 52 | +------------------- |
| 53 | + |
| 54 | + * [General GitHub documentation][gh-help] |
| 55 | + * [GitHub pull request documentation][gh-pr] |
| 56 | + |
| 57 | +[mit-license]: https://opensource.org/licenses/MIT |
| 58 | +[gh-help]: https://help.github.com |
| 59 | +[gh-pr]: https://help.github.com/send-pull-requests |
| 60 | +[adminthemebundle-issues]: https://github.com/avanzu/AdminThemeBundle/issues?utf8=%E2%9C%93&q=is%3Aissue |
| 61 | +[create-issue]: https://github.com/avanzu/AdminThemeBundle/issues/new |
| 62 | +[symfony-standard]: https://github.com/symfony/symfony-standard |
| 63 | +[sf-contribution]: http://symfony.com/doc/current/contributing/documentation/overview.html#your-first-documentation-contribution |
0 commit comments