Thank you for your interest in contributing! This document provides guidelines for contributing to the project. If you have a problem to report or improvement to suggest please open an issue or open a pull request. To do so, please follow the instructions below.
- Use GitHub Issues for bug reports and feature requests
- Include a minimal reproducible example for bugs
- Specify Julia version and package environment details
- Fork the repository and create a new branch for your changes
- Write clear commit messages describing your changes
- Ensure your code follows the project's coding style (see below)
- Include tests for new features or bug fixes
- Update documentation if necessary
- Try to follow the Julia style guide
- Use meaningful variable and function names
- Mathematical symbols and unicode characters as variable names are encouraged if they are properly introduced in the documentation
- Add docstrings to public functions using the standard Julia format
Feel free to open an issue or discussion if you have questions about contributing!