Skip to content

Latest commit

 

History

History
82 lines (49 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

82 lines (49 loc) · 2.49 KB
Raw

How to make your first contribution?

This documentation is to simplify and guide the way beginners make their first contribution. If you are looking to make your first contribution, please follow the steps below.

If you don't have git on your machine, install it.

Fork this repository

Fork this repository by clicking on the fork button on the top of this page. This will result in a copy of this repository in your account.

Clone the repository

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone https://github.com/<your-username>/pixelDust.git

where <your-username> is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer.

Create a branch

Change to the repository directory on your computer (if you are not already there):

cd pixelDust

Now create a branch using the git checkout command:

git checkout -b your-new-branch-name

For example:

git checkout -b add-new-file

Make necessary changes and commit those changes

Now open add or edit file in a text editor. Add code for any existing algorithm in other language or add some new algorithms. Make sure to update correspond README.md file if needed. Now, save the file.

If you go to the project directory and execute the command git status, you'll see there are changes.

Add those changes to the branch you just created using the git add command:

git add "name of the file you add or edit"

Now commit those changes using the git commit command:

git commit -m "Add message for the change"

Push changes to GitHub

Push your changes using the command git push:

git push origin <add-your-branch-name>

replacing <add-your-branch-name> with the name of the branch you created earlier.

Submit your changes for review

  • If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.

  • Now submit the pull request.

  • Soon after reviewing all your changes will be merged into the master branch of this project. You will get a notification email once the changes have been merged.

Where to go from here?

Congrats! You just completed the standard fork -> clone -> edit -> pull request workflow that you'll encounter often as a contributor!