crt0mega
/
mvt
mirror of https://github.com/mvt-project/mvt.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
mvt/CONTRIBUTING.md

1.3 KiB
Raw Permalink Blame History

Contributing

Thank you for your interest in contributing to Mobile Verification Toolkit (MVT)! Your help is very much appreciated.

Where to start

Starting to contribute to a somewhat complex project like MVT might seem intimidating. Unless you have specific ideas of new functionality you would like to submit, some good starting points are searching for TODO: and FIXME: comments throughout the code. Alternatively you can check if any GitHub issues existed marked with the "help wanted" tag.

Code style

When contributing code to

  • Indentation: we use 4-spaces tabs.

  • Quotes: we use double quotes (") as a default. Single quotes (') can be favored with nested strings instead of escaping (\"), or when using f-formatting.

  • Maximum line length: we strongly encourage to respect a 80 characters long lines and to follow PEP8 indentation guidelines when having to wrap. However, if breaking at 80 is not possible or is detrimental to the readability of the code, exceptions are tolerated. For example, long log lines, or long strings can be extended to 100 characters long. Please hard wrap anything beyond 100 characters.