Skip to content

Getting Started

Serhii Dzhepa edited this page Dec 5, 2019 · 7 revisions

Welcome to the Beginner Guides for contributing to Magento! The basic flow for contribution is as follows:

  1. Fork the repository.
  2. Make your fix/feature.
  3. Create a pull request (PR).

This guide will help you get started with the basics.

Getting Started!

  1. Make sure you have a GitHub account.

  2. Fork a repo: Magento 2 repository or other project repo.

  3. Need some coding advice? Review coding guidelines in our DevDocs!

We also recommend adding Two-Factor Authentication (2FA) to protect your GitHub account.

  1. Create a new branch on your fork. Use a name that best describes the work, or references a GitHub issue number.
  2. Code, develop, and work your issue. Enter meaningful commit messages.
  3. Push your branch to your fork to save work.
  4. When ready, create a PR to contribute your code to Magento!

For your very first PR, you will be asked to sign the Magento Contributor Agreement.

What happens next?

  • You can run Travis builds to test your PR.
  • Maintainers and Magento Community Engineering will review your PR.
  • Watch for messages from developers for feedback and requested changes.

We will complete all merges and labeling of your PR. When the PR merges, you receive points based on the work.

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. Or join our weekly Monday beginners call which you can find in our calendar.

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