Skip to content

Latest commit

 

History

History
68 lines (50 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

68 lines (50 loc) · 1.65 KB
Raw

Contributions

Making a PR

Make sure that you fill out the relevant details in the PR.

Guidelines for Merging

The PR which will be having the specific file name as given in the issue, the one whose commit descriptions are relevant, and the code is readable, would be merged.

For docs, make sure that you use markdown syntax. Checkout these links: Markdown Guide, Markdown Cheat-Sheet.

How to Collaborate:

  1. Fork the repository to your own GitHub account.

  2. Clone the repository to your local machine

$ git clone "https://www.github.com/{Username}/Algorithms.git"

where username is your GitHub account username.

  1. Create a branch where you can do your local work. Never work on master branch as we do not allow master commits except by admins.
$ git branch {branchname}
$ git checkout branchname
  1. Do your work and stage your changes.
$ git add <filename>

  1. Commit you changes with a commit message containing your name, file(s) worked upon, changes added.

  2. Push changes to your forked repository

$ git push -u origin branchname
  1. Create a pull request to the upstream repository.

Synchronize forked repository with Upstream repository

  1. Create upstream as our repository
$ git remote add upstream "https://www.github.com/ekdnam/Algorithms"
  1. Fetch upstream changes in local machine
$ git fetch upstream
  1. Switch to master branch
$ git checkout master
  1. Merge changes in local machine
$ git merge upstream/master
  1. Push changes to your forked GitHub repository
$ git push -f origin master