Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

36 lines (26 loc) · 1.28 KB
Raw

How to contribute to Hyperbard's tutorials

Thanks for being willing to contribute to Hyperbard's tutorials! Here are some resources to get you started:

  • Check out open issues in case you are looking for things to tackle.

When contributing code, please be aware that your contribution will fall under the terms of the license.

Pull requests

If you propose some changes, a pull request is the easiest way to integrate them. Please be mindful of the coding conventions (see below) and write good commit messages.

Coding conventions

Above all, consider that this is open source software. It is meant to be used and extended by many people. Be mindful of them by making your code look nice and appealing to them. We cannot build upon some module no one understands.

As a way to obtain some consistency in all contributions, your code in Python scripts should at least be conform with PEP 8.

$ flake8 script.py

PEP8-conforming code formatting in Jupyter Lab can be achieved by loading the nb_black extension installed with the repository's requirements before executing the Jupyter Notebook code: %load_ext lab_black.