Contribution

We welcome contributions from the community to improve Taccel and make it even more useful for everyone. You can pull requests, report issues, or suggest features via our GitHub repo. To contribute to Taccel, please follow the guide:

Code Formatting

Pre-commit Hooks

For developers, please install pre-commit hooks:

sudo apt install pre-commit
pre-commit install

If you use Visual Studio Code, please install install the ruff vscode extension. The .vscode/settings.json is configured aligning with the pre-commit hooks. Whenever you save the file, it will be formatted automatically.

Docstrings

When contributing to the RoboVerse project, the developers are recommended to include the docstrings for their classes, members, functions. The Python PEP 257 - Docstring Conventions provides typical conventions, and the Google Python Style Guide on the Comments and Docstrings provides more details.

Docstrings should be added for:

• all modules, as well as the functions and classes exported by them

• public methods, including the __init__ constructors

• __init__.py, describing the module that it’s for

Please refer to the Sphinx autodoc docs for the format of writing the docstrings, so that they can be automatically included by Sphinx.

After finishing the docstrings for new modules, classes, or functions, you can add register the module within docs/ following the Sphinx autodoc docs so that the docs can automatically generate the docs page for you.