How to contribute

You can contribute using the Gitlab WebIDE by clicking on Edit on GitLab on the webpage (you have to be logged) or following these steps:

  • Go to this Gitlab repository.

  • Clone the repository using SSH or HTTPS: git clone git@gitlab.com:nextbit/handbook)

  • Create a new branch to add novel contents (git checkout -b feature/new-awesome-things) or fix bugs (git checkout -b bugfix/fix-ugly-typo)

  • Make the changes and commit them using an explicatory message (git commit -m 'changing this stuff because of other stuff')

  • Push to remote git push

  • Go to the Gitlab repository and ask for a merge request using the designated button.

  • Wait for the approval from at least one of your colleagues.

What to contribute

Remember, the handbook is a guideline written by everyone: if there is something that you think should be improved or changed, feel free to create a merge request, and we will discuss together about the change.

If there is something that is missing, but you do not know what to write, or you don’t have the time right now, open an issue so we can talk about it.

Markdown

Contents are written using Markdown, but it supports also RST and Sphinx directives.

We use the m2r library to render the page.

A demo document with a list of supported elements is available here, while its source is on Github.