How to contribute

All the documentation is stored on the GitHub page https://github.com/DAP93/SMaLL_best_practices. In this section, you will find some base concepts that will help you to contribute easily to the documentation.

To sum up, every time you want to add/modify something, you need to have a GitHub account and to follow the steps:

  1. Fork the repository.

  2. clone the forked repository locally.

  3. using python 3.5 (or higher), install the minimum required libraries with the command:

  4. Create a branch.

  5. Make your changes.

  6. Compile the HTML files locally and check that all is in the right place. To compile it, use the make script, and in the folder SMaLL_best_practices/docs/build/html you will find all the .html files.

  7. Add your name to the file CREDITS.md.

  8. Push the changes:

    • add all the files

    • commit those changes

    • push your changes

  9. Submit your changes for review.

Important

When you submit the branch to the review, please add some comments to allow the reader to understand what you did.

If you need a more step by step guide, check the subsection Introduction to Git and GitHub.

More info: