|
| 1 | +# Contributing to Zephir Parser |
| 2 | + |
| 3 | +Zephir Parser is an open source project and a volunteer effort. Zephir Parser welcomes contribution from everyone. |
| 4 | +Please take a moment to review this document in order to make the contribution process easy and effective for everyone |
| 5 | +involved. |
| 6 | + |
| 7 | +Following these guidelines helps to communicate that you respect the time of the developers managing and developing this |
| 8 | +open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and |
| 9 | +features. |
| 10 | + |
| 11 | +## Contributions |
| 12 | + |
| 13 | +Contributions to Zephir Parser should be made in the form of [GitHub pull requests][pr]. |
| 14 | +Each pull request will be reviewed by a core contributor (someone with permission to land patches) and either landed in |
| 15 | +the main tree or given feedback for changes that would be required before it can be merged. All contributions should |
| 16 | +follow this format, even those from core contributors. |
| 17 | + |
| 18 | +## Questions & Support |
| 19 | + |
| 20 | +*We only accept bug reports, new feature requests and pull requests in GitHub*. |
| 21 | +For questions regarding the usage of the Zephir Parser or support requests please visit the |
| 22 | +[official forums][forum]. |
| 23 | + |
| 24 | +## Bug Report Checklist |
| 25 | + |
| 26 | +- Make sure you are using the latest released version of Zephir Parser before submitting a bug report. |
| 27 | + Bugs in versions older than the latest released one will not be addressed by the core team |
| 28 | + |
| 29 | +- If you have found a bug it is important to add relevant reproducibility information to your issue to allow us |
| 30 | + to reproduce the bug and fix it quicker. Add a script, small program or repository providing the necessary code to |
| 31 | + make everyone reproduce the issue reported easily. If a bug cannot be reproduced by the development it would be |
| 32 | + difficult provide corrections and solutions. [Submit Reproducible Test][srt] for more information |
| 33 | + |
| 34 | +- Be sure that information such as OS, Zephir Parser versions and PHP version are part of the bug report |
| 35 | + |
| 36 | +- If you're submitting a Segmentation Fault error, we would require a backtrace, please see [Generating a Backtrace][gb] |
| 37 | + |
| 38 | +## Pull Request Checklist |
| 39 | + |
| 40 | +- Don't submit your pull requests to the `master` branch. Branch from the required branch and, |
| 41 | + if needed, rebase to the proper branch before submitting your pull request. |
| 42 | + If it doesn't merge cleanly with master you may be asked to rebase your changes |
| 43 | + |
| 44 | +- Don't put submodule updates, composer.lock, etc in your pull request unless they are to landed commits |
| 45 | + |
| 46 | +- Make sure that the code you write fits with the general style and coding standards |
| 47 | + |
| 48 | +## Getting Support |
| 49 | + |
| 50 | +If you have a question about how to use Zephir Parser, please see the [support page][support]. |
| 51 | + |
| 52 | +## Requesting Features |
| 53 | + |
| 54 | +If you have a change or new feature in mind, please fill an New Featire Request (NFR). |
| 55 | + |
| 56 | +Thanks! <br /> |
| 57 | +Zephir Team |
| 58 | + |
| 59 | +[pr]: https://help.github.com/articles/using-pull-requests/ |
| 60 | +[forum]: https://forum.zephir-lang.com |
| 61 | +[gb]: https://github.com/phalcon/cphalcon/wiki/Generating-a-backtrace |
| 62 | +[support]: https://phalconphp.com/support |
0 commit comments