-
Notifications
You must be signed in to change notification settings - Fork 9.3k
Getting Started
Welcome to the Beginner Guides for contributing to Magento! The basic flow for contribution is as follows:
- Fork the repository.
- Make your fix/feature.
- Create a pull request (PR).
This guide will help you get started with the basics.
-
Make sure you have a GitHub account with Two-Factor Authentication (2FA) to your account. Partners are required to add 2FA protection when contributing to Magento repositories.
-
Sign the Magento Contributor Agreement. You can also sign this with your first PR.
-
Fork a repo: Magento 2 repository or other project repo.
-
Need some coding advice? Review coding guidelines in our DevDocs!
- Create a new branch on your fork. Use a name that best describes the work, or references a GitHub issue number.
- Code, develop, and work your issue. Enter meaningful commit messages.
- Push your branch to your fork to save work.
- When ready, create a PR to get reviews.
If you have any questions, join us in #beginners Slack chat (or self join).
Need to find a project? Check out the Slack Channels (with listed project info) and the Open Source Portal.
Interested in becoming a Magento Contributor? Click here to join our Slack workspace! Then come say hi in #general, follow the #announcements, and browse to find more cool channels!
- Getting Started
- Forking and Branching
- Working with commits
- Working Issues and PRs
- Community Maintainers
- Working with commits
- Magento Contributor Assistant
- Magento Automated Testing
- Test coverage contributions
- Slack Channels
- Magento 2 Core
- Multi Source Inventory
- Coding Standard
- DevDocs
- PHP 8 Compatibility
- Platform Health