tfugnashik / examples

This repo contains examples to implement Machine Learning algorithms
11 stars 8 forks source link
hacktoberfest hacktoberfest2023

Contribute with any of the Machine Learning code samples that you are interested in

Have a look at CONTRIBUTING.md it has some ideas for examples.
Fork this repo and clone it locally and you can start contributing to this repository via github workflow. Some good code samples can be found at examples

A set of guidelines to help you during the contribution process.

Step 1 : Find an issue

Take a look at the Existing Issues or create your own Issues!


Step 2 : Fork the Project

A) fork

A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project. To fork a repository , click on top right corner fork button

image

Next, Keep the default options as it is and click on Create fork

B) git clone

To clone a repository click on code and copy the URL as shown below :

image

open your git bash and type the command as given and to paste URL use shift+insert key

image

Fork this Repository. This will create a Local Copy of this Repository on your Github Profile. Keep a reference to the original project in upstream remote.

$ git clone https://github.com/tfugnashik/examples.git
$ cd examples.git
$ git remote add upstream https://github.com/tfugnashik/examples.git

If you fork the project, update your copy before working by:

$ git remote update
$ git checkout <branch-name>
$ git rebase upstream/<branch-name>

Step 3 : Branch

To Create a new branch:

$ git checkout -b branch_name

It creates new branch. Switch to new branch


Step 4 : Work on the issue assigned

Work on the issue(s) assigned to you.
Add all the files/folders needed. After you've made changes or made your contribution to the project add changes to the branch you've just created by:

Add all new files to branch Branch_Name by:

$ git add .

Step 5 : Commit

To Commit give a descriptive message for the convenience of reviewer by:

$ git commit -m "type your message here"

Step 6 : Work Remotely

Now you are ready to push your work to the remote repository. Once your work is ready and adheres to the project conventions, upload your changes to your fork:

To push your work to your remote repository :

$ git push -u origin Branch_Name

Step 7 : Make a Pull Request

Go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution.

Once your Pull Request has been submitted, it will be reviewed and merged.


Need more help?

You can refer to the following articles:

Forking a Repo
Cloning a Repo
How to create a Pull Request