Most functions in the project still lack docstrings. Contributions welcome — a good starting point
is src/tirith/core/ and each provider's handler.py.
Rules for contributing
- Use the reST docstring format:
"""
Short description.
:param param1: what it is
:returns: what is returned
:raises KeyError: when it raises
"""
- One file per PR, so contributors don't collide on the same file.
- Mention this issue in your PR description (e.g.
Related to #<this issue>).
- PR/commit title format:
<name of the file>.py: Add docstring.
Most functions in the project still lack docstrings. Contributions welcome — a good starting point
is
src/tirith/core/and each provider'shandler.py.Rules for contributing
Related to #<this issue>).<name of the file>.py: Add docstring.