Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (29 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

37 lines (29 loc) · 1.47 KB
Raw

Contributing

Thank you for your interest in contributing to this project! Contributions are welcome and encouraged.

How You Can Contribute

Report Issues

If you encounter a bug, have a question, or want to propose an enhancement, please open an issue on the repository.
When reporting a problem, try to include:

  • A clear and concise description of the issue
  • Steps to reproduce the behavior
  • Expected behavior
  • Environment details (Python version, OS, etc.)
  • Any relevant logs or traceback

Submit Pull Requests

Pull requests (PRs) are highly appreciated. If you'd like to implement a fix or introduce a new feature:

  1. Fork the repository
  2. Create a branch for your changes (git checkout -b feature-name)
  3. Implement your changes with clear, concise commits
  4. Ensure your code follows existing style conventions
  5. Add or update tests if relevant
  6. Submit a pull request describing your changes and the problem they solve

Please keep PRs focused and limited to a single purpose.

Code Style

  • Follow Python best practices and PEP8 style guidelines
  • Write descriptive commit messages
  • Use type hints whenever possible
  • Keep functions small and focused

Communication

Feel free to ask questions or discuss ideas by opening an issue before working on a large feature. This helps avoid duplicated effort and ensures the change aligns with the project goals.

Thank You

Thank you for taking the time to contribute! Your help is valuable and appreciated.