Thank you for your interest in contributing to OptiConn! We welcome contributions from the community to help improve this tool for everyone.
If you find a bug, please open an issue on our GitHub repository. When reporting a bug, please include:
- A clear and descriptive title.
- A detailed description of the issue.
- Steps to reproduce the behavior.
- Expected behavior.
- Screenshots or logs if applicable.
- Your environment details (OS, Python version, DSI Studio version).
We welcome ideas for new features or improvements. Please open an issue to discuss your idea before implementing it.
- Fork the repository and create your branch from
main. - Install dependencies and ensure the environment is set up correctly.
- Make your changes. Ensure your code follows the existing style and conventions.
- Run tests. We have an integrity check suite that must pass:
python scripts/test_integrity_checks.py
- Submit a Pull Request. Provide a clear description of your changes and reference any related issues.
- We follow PEP 8 guidelines for Python code.
- Please use descriptive variable and function names.
- Add comments and docstrings to explain complex logic.
By contributing, you agree that your contributions will be licensed under the MIT License.