Contributing

Thank you for considering contributing to mudu. Contributions of all forms are welcome and appreciated.

The project encourages contributions in the following areas, including but not limited to:

  • Bug fixes and defect resolution

  • Code improvements and performance optimizations

  • Documentation enhancements and tutorial development

  • Issue reporting, feature requests, and design discussions

How to Contribute

  1. Fork the project repository at https://github.com/techkaduna/mudu

  2. Create a new branch for your changes.

  3. Implement your changes, ensuring they align with the existing design and coding standards.

  4. Add new tests or update existing ones where appropriate.

  5. Commit your changes using clear, descriptive commit messages.

  6. Open a pull request with a concise explanation of the motivation, scope, and impact of your changes.

Coding Guidelines

  • Follow the PEP 8 style guide for Python code.

  • Use descriptive and meaningful commit messages.

  • Write clear and comprehensive NumPy/SciPy-style docstrings for public functions, classes, and modules.

  • Maintain consistency with existing naming conventions and architectural patterns.

Testing

mudu uses pytest for automated testing. Before submitting a pull request, run the test suite locally and ensure that all tests pass.

pytest

Pull requests that introduce new functionality should include corresponding test coverage.

Thank you for helping improve mudu and for contributing to its continued development.