Use the GitHub fork & pull model contribution model to submit your code contributions to the Magento Cloud Tools codebase. In this contribution model, you maintain your own fork of the ECE-Tools repository, and create a pull request to submit your proposed changes to the base repository. For details on the fork & pull contribution model, see the Beginners guide.
Contributions can take the form of new features, changes to existing features, tests, bug fixes, or optimizations. You can also contribute new or updated documentation.
The Magento Cloud development team and community maintainers review all issues and contributions submitted by the developer community in first in, first out order (FIFO). During the review process, reviewers might notify a contributor to request clarification on the proposed changes.
You must have a GitHub account with two-factor authentication enabled to contribute to Magento repositories. We also recommend creating a personal access token to use when interacting with GitHub from scripts or from the command line.
- Contributions must adhere to the Magento coding standards.
- When you submit a Pull request (PR), write a meaningful description to explain the purpose of your contribution. Comprehensive descriptions increase the chances that a pull request can be merged quickly, without requests for additional clarification. See the Magento Cloud Tools Pull Request Template for more information.
- Commits must be accompanied by meaningful commit messages.
- If your PR includes bug fixes, provide a step-by-step description of how to reproduce the bug in the pull request description.
- If your PR includes new logic or new features, you must also submit the following information along with the pull request
- Unit/integration test coverage
- Proposed documentation updates: Submit developer documentation contributions to the Magento DevDocs repository. Submit updates to Magento user documentation to the Magento Merchant documentation repository.
- For larger features or changes, open an issue to discuss the proposed changes prior to development. Discussing the updates in advance can prevent duplicate or unnecessary effort and allow other contributors to provide input.
- Search current listed issues (open or closed) for similar proposals of intended contribution before starting work on a new contribution.
- Review and sign the Contributor License Agreement (CLA) if this is your first time contributing. You only need to sign the CLA once.
- Create and test your work.
- Fork the ECE-Tools 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.
- After you submit the pull request, the Magento Cloud development team will review the contribution and collaborate with you as needed to incorporate your proposed changes.
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.
Need to find a project? Check out the Slack Channels (with listed project info) and the Magento Community Portal.