Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 1.94 KB

Contributing.md

File metadata and controls

44 lines (27 loc) · 1.94 KB

Contributing to Machine Learning Projects 101

Thanks for your interest in contributing! Your work can help many Machine Learning developers get started with new projects. Below, you’ll find a simple guide to help you get started.

This repository has a code of conduct—please follow it in all interactions related to this project.


How to Contribute

Have an idea for a Machine Learning project? Here are two ways to contribute:

  1. Have a problem or idea in mind?
    Create an issue, and it’ll be considered for inclusion in the repository.

  2. Want to tackle a project?
    Browse the existing issues to find a project that interests you. If you have a unique project idea that isn't listed, go ahead and create a new issue!

Steps to Contribute Your Project

  1. Fork and Clone the Repository
    First, fork this repository and clone it to your local machine.

  2. Organize Your Project Files

    • Create a new folder dedicated to your project (e.g., Titanic Disaster Prediction).
    • Include:
      • Dataset files
      • Notebook file(s) with your code and explanations
      • Saved model: Save your model using either Joblib or Pickle.
  3. Update the Documentation
    Update the Table of Contents in the README.md to include your project.

  4. Submit a Pull Request
    After updating everything in your forked repository, submit a Pull Request (PR) to this project. I’ll review it and, if everything looks good, it’ll be merged!


I Look Forward to Your PR! 👋


This contribution guide should help make your process smooth and straightforward. If you have questions, feel free to reach out via the repository's issue section. Happy coding!