misc/how-to-create-pull-request.md

In UW-MSDS-DATA-598-Reproducibility-WI20/miao-qian-wang-wei-yang-replication-project: Replication project

Overview

This document describes the simple steps to create a PullRequest for us to collaborate on this project. It's assuming we are all contributors of this repo and all cloned it locally.

Why do I need a PullRequest

Pull requests let you tell others about changes you've pushed to a GitHub repository. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.

Specification

1. Create your new local branch: git checkout -b <your_branch_name>
2. git checkout -b FB-MyName-NewFeature
3. Push this new branch to a new remote branch. git push origin <your_branch_name
4. git push origin FB-MyName-NewFeature

In Github console

1. Create a Pull Request from Git repository page
2. Merge a Pull Request after reviewing the code change
3. Delete the remote branch (optional)

In CampusWire team chat

1. Ping the group of the Pull Request and seek approval before merge. (Optional but recommended for feature change or if you are working in parallel on the same file with other contributors)

Sample PR: https://github.com/mshhh/DATA598A_final_project/pull/1

For details, see this good tutorial

UW-MSDS-DATA-598-Reproducibility-WI20/miao-qian-wang-wei-yang-replication-project documentation built on March 21, 2020, 7 p.m.