Contributing and Feedback Guide
First of all, thank you for taking the time to provide feedback and/or contribute to the training manuals! We’re continually working on improving these documents with community input and we appreciate any feedback, whether it's helping to contribute to further documentation or code, grammar issues, or simply a suggestion or improvement.
If you want to contribute and make changes to the manuals, this page will guide you through the contribution process, outlining which tools we use and the steps you need to follow to contribute.
There are a few ways you can provide feedback:
- The source code for this manual is hosted on Github and uses a service called Gitbook for publishing its documentation.
- The manuals are written using Markdown mark up language.
For contributing to the manual, the following is needed to get started:
This repo has two branches:
master: reserved for production only. The
masterbranch is synced with the Gitbook page for this manual and is only editable by maintainers of this repo.
- Any changes merged in to
masterwill automatically be reflected on Gitbook.
develop: the default branch used for development and content changes.
Trying to edit or create a file in this repository will create your fork automatically. You can then edit pages or create new pages, and commit your changes and file a pull requests one document/issue at a time.
For content changes or new pages, you can use the GitHub online editor:
- Open the page you want to edit on your forked version of the repo on GitHub and press the Edit icon (pen icon).
- When have finalised your changes, scroll to the bottom of the page and write a description of the changes you're proposing under the "Commit changes" ection. Then select
Create a new branch for this commit and start a pull requestand click on
Propose file change. This will direct you to the Pull request page
- On the Pull request page, write a short comment explaining why are proposing those changes and publish your pull request clicking on Create pull request.
Any pull request should be based on the
developbranch. We will not consider pull requests made to
Moderators will review and comment on pull requests. We may suggest changes, improvements, or alternatives, in which case the original contributor will be tagged directly so follow-up instructions are clear. There may be times where moderators will make commits to your fork directly for clarity.