Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (35 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 1.34 KB

🤝 Contributing to ML-Core

Thank you for showing interest in contributing to ML-Core, a beginner-to-intermediate-friendly machine learning repository under HashSlap Summer of Code (HSSoC)!

🛠 Getting Started

  1. Fork the Repository

  2. Clone your Fork

    git clone https://github.com/your-username/ml-core.git
cd ml-core

  3. Create a New Branch

    git checkout -b your-feature-name

  4. Make Changes and Commit

    • Write clean and commented code

    • Use clear commit messages:

      git commit -m "Add linear regression example to supervised folder"

  5. Push and Create a Pull Request

    git push origin your-feature-name
    • Open a PR linking to the relevant issue (e.g., Closes #5)

🧾 Contribution Guidelines

  • 📁 Place your work under the correct topic folder (e.g., supervised, unsupervised)
  • 🧪 Test your scripts before pushing
  • 📝 Add helpful comments and update README if needed
  • ✅ Use meaningful commit messages
  • 🗣 Respect feedback from maintainers

📚 Resources

  • Read the README for structure and goals
  • Check open Issues to get started

🌟 Thank you for contributing to ML-Core and being part of the HSSoC community!