Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Become a Contributor

Leslie Tilling edited this page Apr 13, 2020 · 3 revisions

Share your knowledge with the community by contributing to the Magento User Guide! You can contribute by creating an issue or pull request (PR) on our MerchDocs GitHub repository. We welcome all types of contributions, which is everything from minor typo fixes to new topics.

Magento Documentation staff members review issues and pull requests on a regular basis. We do our best to address all issues as soon as possible, but working through the backlog takes time. We appreciate your patience.

Rewards for contributions

Magento Documentation coordinates with Magento Community Engineering teams and projects. As you contribute PRs, you gain Contribution Points. Contribution points are calculated according to the assessment results. We award these points when the PR is merged.

We are thankful for all contributions, and we always recognize our most active members. Our aim is to find and recognize our top contributors according to points awarded during a given time period (monthly/quarterly/yearly). Contributors can earn points in numerous ways with a focus on pull requests (PR) to the backlog and special projects.

Start your contribution journey

If you are not a developer and do not use git source control and local build environments, you can still contribute to the Magento User Guides! Anyone can create a GitHub account (it's free!) and make content changes and additions through the GitHub web UI.

  1. Make sure you have a GitHub account.

  2. Fork the MerchDocs repository.

    See Fork a repo for information about adding a forked repository to your account.

  3. Write content. You have two options:

    • Write in GitHub: Edit and add files through your GitHub account in a web browser.

    • Write like a Developer: Edit and add files in a text editor or developer environment (IDE) on your local computer.

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