-
Notifications
You must be signed in to change notification settings - Fork 3
/
pull-request-tutorial.html
66 lines (51 loc) · 4.4 KB
/
pull-request-tutorial.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="description" content="MSDK : Mass Spectrometry Development Kit">
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
<title>MSDK: tutorial</title>
</head>
<body>
<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/msdk">View on GitHub</a>
<img src="images/msdk_logo.png" width="90" height="90" align="left" style="background: white; margin-right: 25px;">
<h1 id="project_title">MSDK</h1>
<h2 id="project_tagline">Mass Spectrometry Development Kit</h2>
</header>
</div>
<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
<h3>
<a id="how-to-join-this-project" class="anchor" href="#how-to-join-this-project" aria-hidden="true"><span class="octicon octicon-link"></span></a>How to contribute to MSDK</h3>
<p>
There are several steps you need to follow in order to contribute your code to MSDK. If you are not familiar with GitHub, this might seem cumbersome at first, but you will surely appreciate the power of this <a href="https://guides.github.com/introduction/flow/">workflow</a> later. Steps 1-3 only need to be performed once, when you make your first contribution.
</p>
<ol>
<li><a href="https://github.com/join">Create</a> a personal account on GitHub.</li>
<li><a href="https://help.github.com/articles/fork-a-repo/">Fork the MSDK repository</a>. Now you have created your own, personal copy of MSDK at GitHub.</li>
<li><a href="https://help.github.com/articles/fork-a-repo/#step-2-create-a-local-clone-of-your-fork">Clone</a> the newly forked git repository (https://github.com/<strong>YOUR-USERNAME</strong>/msdk.git) to your PC, either using the <em>git clone</em> command, or using your favorite <a href="http://en.wikibooks.org/wiki/Java_Programming/Java_IDEs">IDE</a>. Now you have created a local copy of your own GitHub repository. This copy will contain the <em>master</em> branch.</li>
<li>In your local, cloned repository, <a href="http://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging">create and check out a new branch</a> for the feature or change that you are planning to work on.</li>
<li>Perform your development on this new branch, and <a href="http://git-scm.com/docs/git-commit">commit</a> your changes with meaningful commit messages (multiple commits are fine). Note that all commits happen only within your local git repository.</li>
<li>When you are finished, <a href="https://help.github.com/articles/pushing-to-a-remote/">push your branch</a> to your on-line repository on GitHub.</li>
<li>Go to the website of your repository on GitHub and <a href="https://help.github.com/articles/using-pull-requests/#initiating-the-pull-request">create a pull request</a> to the original MSDK repository's <em>master</em> branch. We will review your pull request and provide comments. You can update your code and push new commits into the same branch of your own GitHub repository. These commits will be automatically added to the pull request.</li>
<li>When everyone is happy, we will merge your pull request and you can <a href="https://help.github.com/articles/deleting-unused-branches/">delete your branches</a>.</li>
<li>You can keep your local repository up-to-date with the MSDK development branch by <a href="https://help.github.com/articles/configuring-a-remote-for-a-fork/">adding</a> the official MSDK repository as a new <em>remote</em> repository and <a href="https://help.github.com/articles/syncing-a-fork/">fetching changes</a> from there.</li>
</ol>
<p>For more information, please check the official GitHub's <a href="https://help.github.com">documentation</a> or ask for help through our <a href="https://groups.google.com/forum/#!forum/msdk-devel">Google Group</a>.</p>
<p>Before creating a Pull Request, please make sure that you agree with your code being distributed as part of MSDK under its <a href="index.html#license">license</a>.</p>
<p><a href="index.html">Return to main page</a></p>
</section>
</div>
<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
<p>Published with <a href="http://pages.github.com">GitHub Pages</a></p>
</footer>
</div>
</body>
</html>