Developers Guide

• 1: Contribution Guidelines
• 1.1: Contribute to Documentation
• 1.2: Contribue to Magento CLI

1 - Contribution Guidelines

1.1 - Contribute to Documentation

Contributing to Docs

We use Hugo to format and generate our website, the Docsy theme for styling and site structure, and Github Actions to manage the deployment of the site. Hugo is an open-source static site generator that provides us with templates, content organisation in a standard directory structure, and a website generation engine. You write the pages in Markdown (or HTML if you want), and Hugo wraps them up into a website.

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Updating a single page

If you’ve just spotted something you’d like to change while using the docs, Docsy has a shortcut for you:

1. Click Edit this page in the top right hand corner of the page.
2. If you don’t already have an up to date fork of the project repo, you are prompted to get one - click Fork this repository and propose changes or Update your Fork to get an up to date version of the project to edit. The appropriate page in your fork is displayed in edit mode.
3. Follow the rest of the Quick start with Netlify process above to make, preview, and propose your changes.

Creating an issue

If you’ve found a problem in the docs, but you’re not sure how to fix it yourself, please create an issue in the Goldydocs repo. You can also create an issue about a specific page by clicking the Create Issue button in the top right hand corner of the page.

Useful resources

• Docsy user guide: All about Docsy, including how it manages navigation, look and feel, and multi-language support.
• Hugo documentation: Comprehensive reference for Hugo.
• Github Hello World!: A basic introduction to GitHub concepts and workflow.

1.2 - Contribue to Magento CLI

Contributing to Magento CLI

We love pull requests!

Fork, then clone the repo:

    git clone git@github.com:your-username/magento-cli.git

Set up your machine:

    cd magento-cli
    make build

Make sure the existing tests pass:

    make test

While creating new commands, don’t forget to create a _test.go file.

Make your changes, Add tests for your change, Make the tests pass:

    make test

Make your change. Add tests for your change. Make the tests pass:

    make test

Push to your fork and submit a pull request.

At this point you’re waiting on us. We like to at least comment on pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted:

• Write tests.
• Write a good commit message.