Source Code and Contributors¶
The source code for the Riemannian STATS package is publicly available on GitHub:
GitHub Repository¶
🔗 GitHub Repository: https://github.com/OldemarRodriguez/riemannian_stats.git
You can visit the repository to:
Access the complete source code
Report issues or suggest improvements
Fork the project and contribute
Contributing Guide¶
Thank you for your interest in contributing to the Riemannian STATS project! Contributions of all types are welcome, code improvements, bug reports, documentation enhancements, and feature suggestions.
How to Contribute¶
Reporting Issues¶
Reporting issues or bugs is one of the simplest ways to help improve the project.
Check the existing issues first to avoid duplication.
Clearly describe the issue and steps to reproduce it, if possible.
Include relevant details like Python version, operating system, and error messages.
You can open a new issue here.
Contributing Documentation¶
Good documentation is vital. Improvements to clarity, completeness, or readability are especially helpful.
To contribute documentation:
Fork the repository.
Make your changes to documentation files (located in the
/docs
directory).Submit a pull request (PR) clearly explaining your documentation improvements.
Building Documentation Locally¶
To build documentation locally:
pip install -r docs_requirements.txt
sphinx-build -b html docs/ docs/html/
You can view the built documentation by opening docs/html/index.html
in a browser.
Contributing Code¶
Contributions in the form of code enhancements, bug fixes, and new features are encouraged!
Follow these steps:
Fork the repository to your GitHub account.
Clone the repository locally:
git clone https://github.com/OldemarRodriguez/riemannian_stats.git
Create a new branch for your changes:
git checkout -b feature/my-new-feature
Make your changes and commit them clearly:
git commit -am "Add my-new-feature"
Push your changes back to GitHub:
git push origin feature/my-new-feature
Submit a pull request clearly explaining your changes.
Code Formatting¶
To maintain consistency, please format your code using Black before submitting your pull request:
pip install black
black .
Running Tests¶
Please ensure all existing unit tests pass and consider adding new tests for your changes:
Using unittest:
python -m unittest discover tests
Or using pytest
:
pytest tests
Pull Request Reviews¶
The maintainers will review your pull request and may suggest improvements. Communication and iteration are key-don’t hesitate to ask questions or discuss alternatives!
Questions?¶
Feel free to open an issue or contact the maintainers if you have any questions. Your contributions and feedback are greatly appreciated!
Contributors¶
This package is developed and maintained by:
Oldemar Rodríguez Rojas – oldemar.rodriguez@ucr.ac.cr
Jennifer Lobo Vásquez – jennifer.lobo.vasquez@gmail.com
We welcome contributions from the community! If you are interested in contributing, please open an issue or submit a pull request on GitHub.
Thank you to everyone who supports and improves Riemannian STATS.