Skip to content

Commit b7eb230

Browse files
committed
Add guide for github pull requests
1 parent b04f46f commit b7eb230

File tree

5 files changed

+29
-0
lines changed

5 files changed

+29
-0
lines changed

docs/HowToPullRequest.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Github Pull Request
2+
3+
## **1-Creating a Pull Request**
4+
5+
This guide assumes that you have followed the guide for forking a repository and have made modifications to your local fork that you intend to request be merged
6+
into the original repository. To start you go to your github repository main page and select the contribute button and then select "Open pull request"
7+
8+
![](../images/images_for_pull_request/CreatePull.png)
9+
10+
This will take you to the pull request form for the main repository which should contain a template for the information that needs to be filled out to create a
11+
successful pull request.
12+
13+
![](../images/images_for_pull_request/PullRequestMain.png)
14+
15+
The main interface is broken into two main sections
16+
17+
![](../images/images_for_pull_request/PullRequestBranch.png)
18+
19+
The top section is a branch selection dialog that should automatically be filled out properly. On the right is the repository that you are requesting the
20+
pull request to, as you clicked this from your repository it should be the NIGMS equivalent. Next is the branch of that repository which should be main.
21+
The next section is the repository you are requesting a pull request from, this should be the repository that you modified and then the branch that your modification
22+
is on.
23+
24+
![](../images/images_for_pull_request/PullRequestMessage.png)
25+
26+
The final section is the location where you add a title for your particular request and a description of what changes your pull request has made. A good pull request
27+
will explain exactly what problem you are solving with your modification, why it should be merged, and what has been changed as an overview. The template for NIGMS
28+
repositories also has a checklist that should be completed before a pull request is submitted.
29+
71.7 KB
Loading
6.86 KB
Loading
81.9 KB
Loading
32.3 KB
Loading

0 commit comments

Comments
 (0)