Contributing - VladimirSiv/pytransflow GitHub Wiki

First off, thanks for taking the time and showing interest in pytransflow!

All skill levels are welcome to contribute! Whether you're a beginner or an experienced developer, your input is valuable.

How Can I Contribute?

Reporting Bugs

• Use the GitHub issue tracker to report any bugs or request new features
• Ensure the bug was not already reported by searching through existing issues

Suggesting Enhancements

• Use the GitHub issue tracker to suggest enhancements
• Label them with the "enhancement" tag

Pull Requests

• Fork the repo and create your branch from main
• If you've added code that should be tested, add tests
• Ensure your code lints properly, by running poetry run linters
• Make sure that your tests have 100% coverage, by running poetry run tests
• Issue that pull request

Code Style

This project follows Google's Python Style Guide, please adhere to these guidelines in your contributions.

Additionally, this project is using sphinx python library to generate the documentation pages, these pages are generated from docstrings written in Google's style, for more examples and additional information about this style please check Example Google Style Python Docstrings

While developing use helper scripts like poetry run linters to resolve any potential misalignment with the project's style.