Contributing to documentation

[mairas]

A small tip/suggestion/request wrt. contributing to the SensESP documentation (or any other documentation hosted on GitHub, for that matter): it's easy and straightforward to do even if you wouldn't know how to do pull requests or any other Git operations! You just need to have a GitHub account. I often use this method myself to do smaller changes in the project documentation.

Here's how:

First, find the documentation "source" page on GitHub. For SensESP, the documentation has been written in Markdown, and every documentation page has an "Edit this page on GitHub" link at the very bottom. (For example, the see the Migrating page.) For some other repos, you might have to browse the repository contents directly.

When you've found the page you want to edit, click on the pen symbol of the top right corner of the file view, shown circled in the screenshot below. An editor view will appear. You can then do the corrections and additions you wanted.

Once you're finished with your changes, scroll down and give your commit a short but descriptive commit message and click the green "Propose changes" button. You'll land on a page comparing the changes you've made. Click on the green "Create pull request" button.

You'll then get to modify the pull request title and description. Provide some short information on the PR contents so that the maintainers and other PR reviewers can have an idea what it's all about. It doesn't have to be long! Finally, click on the green "Create pull request" button to make the PR.

And that's it! A maintainer for the project will review the changes and merge it or possibly discuss the changes.