|
| 1 | +# Contributing to Magento Coding Standard code |
| 2 | + |
| 3 | +Contributions to the Magento Coding Standard codebase are done using the fork & pull model. |
| 4 | +This contribution model has contributors maintaining their own fork of the Magento Coding Standard repository. |
| 5 | +The forked repository is then used to submit a request to the base repository to “pull” a set of changes. |
| 6 | +For more information on pull requests please refer to [GitHub Help](https://help.github.com/articles/about-pull-requests/). |
| 7 | + |
| 8 | +Contributions can take the form of new components or features, changes to existing features, tests, documentation (such as developer guides, user guides, examples, or specifications), bug fixes or optimizations. |
| 9 | + |
| 10 | +The Magento Coding Standard development team or community maintainers will review all issues and contributions submitted by the community of developers in the first in, first out order. |
| 11 | +During the review we might require clarifications from the contributor. |
| 12 | +If there is no response from the contributor within two weeks, the pull request will be closed. |
| 13 | + |
| 14 | +For more detailed information on contribution please read our [beginners guide](https://github.com/magento/magento2/wiki/Getting-Started). |
| 15 | + |
| 16 | +## Contribution requirements |
| 17 | + |
| 18 | +1. Contributions must adhere to the [Magento coding standards](https://devdocs.magento.com/guides/v2.3/coding-standards/bk-coding-standards.html). |
| 19 | +2. Pull requests (PRs) must be accompanied by a meaningful description of their purpose. Comprehensive descriptions increase the chances of a pull request being merged quickly and without additional clarification requests. |
| 20 | +3. Commits must be accompanied by meaningful commit messages. |
| 21 | +4. PRs which include bug fixes must be accompanied with a step-by-step description of how to reproduce the bug. |
| 22 | +3. PRs which include new logic or new rules must be submitted along with: |
| 23 | +* Unit test coverage |
| 24 | +* Proposed [documentation](https://devdocs.magento.com) updates. Documentation contributions can be submitted via the [devdocs GitHub](https://github.com/magento/devdocs). |
| 25 | +4. For larger features or changes, please [open an issue](https://github.com/magento/magento-coding-standard/issues) to discuss the proposed changes prior to development. This may prevent duplicate or unnecessary effort and allow other contributors to provide input. |
| 26 | +5. All automated tests must pass (all builds on [Travis CI](https://travis-ci.com/github/magento/magento-coding-standard) must be green). |
| 27 | + |
| 28 | +## Contribution process |
| 29 | + |
| 30 | +If you are a new GitHub user, we recommend that you create your own [free github account](https://github.com/signup/free). |
| 31 | +This will allow you to collaborate with the Magento Coding Standard development team, fork the Magento Coding Standard project and send pull requests. |
| 32 | + |
| 33 | +1. Search current [listed issues](https://github.com/magento/magento-coding-standard/issues) (open or closed) for similar proposals of intended contribution before starting work on a new contribution. |
| 34 | +2. Review the [Contributor License Agreement](https://magento.com/legaldocuments/mca) if this is your first time contributing. |
| 35 | +3. Create and test your work. |
| 36 | +4. Fork the Magento Coding Standard repository according to the [Fork A Repository instructions](https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#fork) and when you are ready to send us a pull request – follow the [Create A Pull Request instructions](https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#pull_request). |
| 37 | +5. Once your contribution is received the Magento Coding Standard development team will review the contribution and collaborate with you as needed. |
| 38 | + |
| 39 | +## Code of Conduct |
| 40 | + |
| 41 | +Please note that this project is released with a Contributor Code of Conduct. We expect you to agree to its terms when participating in this project. |
| 42 | +The full text is available in the repository [Wiki](https://github.com/magento/magento2/wiki/Magento-Code-of-Conduct). |
| 43 | + |
| 44 | +## Connecting with Community! |
| 45 | + |
| 46 | +If you have any questions, join us in [#beginners](https://magentocommeng.slack.com/messages/CH8BGFX9D) Slack chat. If you are not on our slack, [click here](http://tinyurl.com/engcom-slack) to join. |
| 47 | + |
| 48 | +Need to find a project? Check out the [Slack Channels](https://github.com/magento/magento2/wiki/Slack-Channels) (with listed project info) and the [Magento Community Portal](https://opensource.magento.com/). |
0 commit comments