Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
101 lines (70 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

101 lines (70 loc) · 2.79 KB

Contributing to this Project

Thank you for your interest in contributing! 🎉
We welcome contributions of all kinds: bug reports, feature requests, documentation improvements, and code contributions.

📝 How to Contribute

1. Reporting Issues

  • Check the existing Issues first to see if your problem or suggestion already exists.
  • If not, open a new issue and provide:
    • A clear description of the problem or feature
    • Steps to reproduce (if applicable)
    • Expected behavior vs actual behavior
    • Environment details (Python version, OS, library versions)

2. Suggesting Features

  • Open a new issue labeled enhancement or feature request.
  • Provide context, use cases, and examples if possible.
  • Keep the request clear and concise.

3. Code Contributions (Pull Requests)

We love pull requests! 💖 Here's how to make them smooth:

  1. Fork the repository and clone your fork locally.

  2. Create a branch for your work:

    git checkout -b feature/your-feature-name

  3. Make your changes with clear, readable code.

  4. Follow the project’s coding style (PEP 8 for Python projects).

  5. Write tests for new features or bug fixes.

  6. Run all tests and ensure they pass.

  7. Commit your changes with clear messages:

    git add .
git commit -m "Add feature X"

  8. Push your branch to your fork:

    git push origin feature/your-feature-name

  9. Open a pull request on the main repository.

    • Describe what you changed and why.
    • Reference related issues with #issue_number.

4. Code Review

  • Be respectful and constructive.
  • Discuss changes openly; suggestions are for improving quality.
  • Maintain clarity and readability in all commits.

5. Style & Best Practices

  • Keep functions and classes small and focused.
  • Use descriptive variable and function names.
  • Comment non-obvious logic.
  • Use consistent formatting (consider using black or isort for Python).

6. Documentation

  • Contributions to documentation are welcome.
  • Update README, docstrings, or examples as needed.
  • Keep explanations clear and concise.

7. Testing

  • Write tests for any new functionality.
  • Ensure tests pass on your local environment before submitting.
  • Use automated testing if the project supports it.

🚀 Thank You!

Contributing is a big help and greatly appreciated. Even small fixes like typo corrections, documentation improvements, or clarifying code comments make a difference! 💖

References