👍🎉 First off, thanks for taking the time to contribute! 🎉👍
Before creating bug reports, please check existing issues list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible in the issue using the 🐛 bug report issue template.
For concrete ideas, open new issue using the 🚀 feature request template.
To start a or participate in a discussion, head over to https://github.com/Infineon/StreamGen/discussions
Fill in the pull request template and make sure your code is documented.
- Poetry: https://python-poetry.org/docs/
After installing Poetry and cloning the project from GitHub, you should run the following command from the root of the cloned project:
poetry install --all-extras --sync --compileAll of the project's dependencies should be installed and the project ready for further development.
To activate the newly created virtual environment, call poetry shell.
StreamGen uses Poe the Poet as a task runner, to document common workflows and simplify their invocation.
Poe tasks are defined in the pyproject.toml file.
Manually run the tests:
poe testBuild the documentation locally:
poe docs_localBuild and publish docs:
poe docs