Skip to content

Latest commit

 

History

History
105 lines (68 loc) · 4.29 KB

CONTRIBUTING.md

File metadata and controls

105 lines (68 loc) · 4.29 KB
Raw

Contributing to AI-ML-Roadmap-from-scratch 🤝🏽

I'm thrilled you're interested in contributing to this repository and helping others embark on their exciting journeys into AI and Machine Learning! This guide outlines how you can effectively contribute valuable resources and enhance the overall learning experience.

How to Contribute

There are several ways you can contribute to this project:

1. Adding New Resources:

  • Identify high-quality resources (courses, tutorials, books, etc.) that align with the roadmap's structure and progression levels.
  • Ensure the resources are credible and well-regarded in the AI/ML learning community. Prioritize free or affordable options whenever possible.
  • Identify which module it belongs to.
  • Follow the existing format in the README.md file for consistency. Include details like:
    • Resource title.
    • Type of resource (e.g., YouTube, Website, Blog, Course, etc.).
    • Link to the resource (URL).

2. Improving Existing Resources:

  • Review the current resources and suggest corrections or updates if necessary.
  • Provide feedback on the resource's effectiveness, clarity, or value for specific learning levels.
  • Create a pull request (PR) or open an issue outlining your proposed changes or additions.

Before Submitting a Pull Request

  • Thoroughly review the README.md file to ensure your contribution aligns with the existing structure and content.
  • Search for existing issues that might address your proposed addition or update.
  • Test any new links you add to resources to verify they function correctly.
  • Write clear and concise commit messages that describe your changes.

Creating a Pull Request

Here's a step-by-step guide on creating a pull request:

  1. Fork this repository:

    • Visit this repository's URL: https://github.com/aadi1011/AI-ML-Roadmap-from-scratch
    • Click the "Fork" button in the top right corner. This creates a copy of the repository in your own GitHub account.
    • You can directly edit on your GitHub Web and submit a pull request (skip to step 6) or edit on your local machine (continue with step 2)

  2. Clone your forked repository to your local machine:

    • You'll need Git installed on your system. If you don't have it, follow the installation instructions from https://git-scm.com/downloads.

    • Open a terminal and use the git clone command to clone your forked repository. Replace <your-username> with your GitHub username:

      git clone https://github.com/<your-username>/AI-ML-Roadmap-from-scratch.git

    • This creates a local copy of the repository on your machine.

  3. Make your changes:

    • Open the cloned repository in your preferred code editor.
    • Make your edits to the README.md file, adding your new resources or suggesting changes to existing ones.

  4. Commit your changes:

    • In your terminal, navigate to the cloned repository directory using cd:

      cd AI-ML-Roadmap-from-scratch

    • Use Git to add your modified files to the staging area:

      git add README.md

    • Commit your changes with a descriptive message using git commit:

      git commit -m "Added new resource on Deep Learning"

      Replace "Added new resource on Deep Learning" with a clear message that reflects your contribution.

  5. Push your changes to your forked repository:

    • Push your committed changes to your forked repository on GitHub:

      git push origin main

  6. Create a pull request:

    • Go to your forked repository on GitHub https://github.com/<your-username>/AI-ML-Roadmap-from-scratch.
    • Click on the "Pull requests" tab.
    • Click the green "New pull request" button.
    • You'll see a comparison between your branch and the main branch of the original repository.
    • Add a clear and concise title and description for your pull request, explaining the changes you made.
    • Click the "Create pull request" button to submit your request.

Code Style and Formatting

  • Maintain consistent formatting and indentation as in the existing code.

We appreciate your contributions!

If you have any questions or suggestions, feel free to create an issue or reach out to the repository maintainer.