Contributing

We welcome contributions to LeakPy! This document provides guidelines for contributing.

Getting Started

  1. Fork the repository: https://github.com/Chocapikk/LeakPy

  2. Clone your fork: git clone https://github.com/yourusername/LeakPy.git

  3. Create a branch: git checkout -b feature/your-feature-name

  4. Make your changes

  5. Run tests: python -m unittest discover -s tests

  6. Commit your changes: git commit -m "Add your feature"

  7. Push to your fork: git push origin feature/your-feature-name

  8. Open a Pull Request

Code Style

  • Follow PEP 8 style guide

  • Use meaningful variable names

  • Add docstrings to functions and classes

  • Keep functions focused and small

Testing

  • Write tests for new features

  • Ensure all tests pass before submitting

  • Run: python -m unittest discover -s tests -v

Documentation

  • Update documentation for new features

  • Add examples when appropriate

  • Keep docstrings up to date

Reporting Issues

When reporting issues, please include:

  • Python version

  • LeakPy version

  • Steps to reproduce

  • Expected behavior

  • Actual behavior

  • Error messages (if any)

Questions?

Feel free to open an issue on GitHub if you have any questions or need help.