All pull requests are welcome, however, do note that the maintainer of the project is a full time university student, thus may not be able to respond as fast as you may expect.
-
If you are planning to introduce a big change in codebase, open an issue first for discussion, that waste of time would be avoided.
-
The project is currently written in Python 3.10, with strict compliance to PEP-0008 in terms of formatting, and to PEP-0257 in regards of docstring formatting, with slight modification for sake of consistency. The modifications include:
In lists, as well as declaration of variables, there is always indent after line break:
hello_world: list[str] = [
"a", "b", "c",
"d", "e", "f",
...,
]
# not this one
hello_world: list[str] = [
"a", "b", "c",
"d", "e", "f",
...,
]
"""However, in function calls, indent is not required"""
hello_from_long_function(
"arguments", "argument_2", "argument_3"
)Moreover, the project strictly requires lines to be limited to 72 chars.
Rules to type checking is provided by
PEP-0484, and is checked by
mypy, which requires
type-setuptools and type-requests.
-
Be sure to run the checks and test your code first before opening pull requests, the unit test can be invoked with
./check.sh. -
Always comply to CODE_OF_CONDUCT.