Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 3.3 KB
Raw

Contributing to Magento 2 code

Contributions to the Magento 2 codebase are done using the fork & pull model. This contribution model has contributors maintaining their own copy of the forked codebase (which can easily be synced with the main copy). The forked repository is then used to submit a request to the base repository to “pull” a set of changes (hence the phrase “pull request”).

Contributions can take the form of new components/features, changes to existing features, tests, documentation (such as developer guides, user guides, examples, or specifications), bug fixes, optimizations or just good suggestions.

The Magento 2 development team 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 for two weeks, the issue is closed.

Contribution requirements

  1. Contributions must adhere to 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 to be merged quickly and without additional clarification requests.
  3. Commits must be accompanied by meaningful commit messages.
  4. PRs which include bug fixing, must be accompanied with step-by-step description of how to reproduce the bug.
  5. PRs which include new logic or new features must be submitted along with:
  • Unit/integration test coverage (we will be releasing more information on writing test coverage in the near future).
  • Proposed documentation update. Documentation contributions can be submitted here.
  1. For large features or changes, please open an issue and discuss first. This may prevent duplicate or unnecessary effort, and it may gain you some additional contributors.
  2. All automated tests are passed successfully (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. By doing that, you will be able to collaborate with the Magento 2 development team, “fork” the Magento 2 project and be able to easily 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 2 repository according to Fork a repository instructions and when you are ready to send us a pull request – follow Create a pull request instructions.
  5. Once your contribution is received, Magento 2 development team will review the contribution and collaborate with you as needed to improve the quality of the contribution.