Contribution guidelines

[aldesantis]

Hello! 👋 If you're here, it means you want to contribute to the new version of the Solidus Developer Guides. That's awesome, and I want to give you a few pointers on where to start!

Gitbook integration

This repository is linked to a Gitbook project and deployed at https://edgeguides.solidus.io. Each push to the master branch will trigger a deployment of the guides.

For writing, you can use Markdown and you can leverage all of Gitbook's custom features such as hints and tabs. In fact, you're strongly encouraged to use both hints and tabs in order to better organize the content.

If you need some inspiration, look at some of the existing guides in this repository.

How to contribute

There are different ways to contribute to the new guides:

• By writing the missing guides. Just pick a piece of content that is missing and go for it! If you want to propose adding a new chapter or moving chapters around, please open an issue first, as we put a lot of work into the new table of contents.
• By reviewing and testing the existing content. We're pushing out a lot of documentation and it's easy to screw up. Reviewing the content that's already been written to make sure it's up-to-date and working is one of the most important things you can do.
• By improving the YARD documentation. We're in the process of moving content from the old guides to here, but much of the old content is actually better suited for YARD documentation than actual guides. The work we're doing is two-fold: on one hand, we're completing the new guides; on the other, we're moving everything that doesn't belong in the guides to the YARD documentation of the core gems. (A list of what we think should go into the YARD documentation will come soon.)

We need help in all three of these areas, so don't be shy!

I'm stuck! What do I do?

Ping @aldesantis here on GitHub or @alessandro in the Solidus Slack workspace.