Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 1.88 KB
Raw

How to Pull Request

You will need basic git proficiency to be able to PR. git is not the easiest tool to use but it has the greatest manual. Type git --help in a shell and enjoy. If you prefer books, Pro Git is a very good reference.

Follow these steps to start contributing:

  1. Fork the repository by clicking on the 'Fork' button on the repository's page. This creates a copy of the code under your GitHub user account.

  2. Clone your fork to your local disk, and add the base repository as a remote:

    $ git clone [email protected]:<your Github handle>/machine-learning20f-learning4good-projects.git
$ cd machine-learning20f-learning4good-projects
$ git remote add upstream https://github.com/Qdata4Capstone/machine-learning20f-learning4good-projects

  3. Create a new branch to hold your development changes:

    $ git checkout -b a-descriptive-name-for-my-changes

    do not work on the master branch.

  4. Add your code and report on your branch.

    Once you're happy with your changes, add changed files using git add and make a commit with git commit to record your changes locally:

    $ git add modified_files
$ git commit

    Please write good commit messages.

    It is a good idea to sync your copy of the code with the original repository regularly. This way you can quickly account for changes:

    $ git fetch upstream
$ git rebase upstream/master

    Push the changes to your account using:

    $ git push -u origin a-descriptive-name-for-my-changes

  5. Once you are satisfied, go to the webpage of your fork on GitHub. Click on 'Pull request' to send your changes to the project maintainers for review.