Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 4.25 KB

CONTRIBUTING.md

File metadata and controls

48 lines (34 loc) · 4.25 KB
Raw

Contributing to Magento Coding Standard code

Contributions to the Magento Coding Standard codebase are done using the fork & pull model. This contribution model has contributors maintaining their own fork of the Magento Coding Standard repository. The forked repository is then used to submit a request to the base repository to “pull” a set of changes. For more information on pull requests please refer to GitHub Help.

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.

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. During the review we might require clarifications from the contributor. If there is no response from the contributor within two weeks, the pull request will be closed.

For more detailed information on contribution please read our beginners guide.

Contribution requirements

  1. Contributions must adhere to the Magento coding standards.
  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.
  3. Commits must be accompanied by meaningful commit messages.
  4. PRs which include bug fixes must be accompanied with a step-by-step description of how to reproduce the bug.
  5. PRs which include new logic or new rules must be submitted along with:
  1. For larger features or changes, please open an issue to discuss the proposed changes prior to development. This may prevent duplicate or unnecessary effort and allow other contributors to provide input.
  2. All automated tests must pass (all builds on Travis CI must be green).

Contribution process

If you are a new GitHub user, we recommend that you create your own free github account. This will allow you to collaborate with the Magento Coding Standard development team, fork the Magento Coding Standard project and send pull requests.

  1. Search current listed issues (open or closed) for similar proposals of intended contribution before starting work on a new contribution.
  2. Review the Contributor License Agreement if this is your first time contributing.
  3. Create and test your work.
  4. Fork the Magento Coding Standard repository according to the Fork A Repository instructions and when you are ready to send us a pull request – follow the Create A Pull Request instructions.
  5. Once your contribution is received the Magento Coding Standard development team will review the contribution and collaborate with you as needed.

Code of Conduct

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. The full text is available in the repository Wiki.

Connecting with Community!

If you have any questions, join us in #beginners Slack chat. If you are not on our slack, click here to join.

Need to find a project? Check out the Slack Channels (with listed project info) and the Magento Community Portal.