-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathgithub_data.html
More file actions
218 lines (192 loc) · 11.6 KB
/
github_data.html
File metadata and controls
218 lines (192 loc) · 11.6 KB
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
<!DOCTYPE HTML>
<!--
Phantom by HTML5 UP
html5up.net | @ajlkn
Free for personal and commercial use under the CCA 3.0 license (html5up.net/license)
-->
<html>
<head>
<title>GitHub</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no" />
<link rel="stylesheet" href="assets/css/main.css" />
<noscript><link rel="stylesheet" href="assets/css/noscript.css" /></noscript>
</head>
<body class="is-preload">
<!-- Wrapper -->
<div id="wrapper">
<!-- Header -->
<header id="header">
<div class="inner">
<!-- Logo -->
<a href="index.html" class="logo">
<span class="symbol"><img src="images/NeuroNestLogo.png" alt="NeuroNest Logo" /></span><span class="title">NeuroNest</span>
</a>
<!-- Nav -->
<nav>
<ul>
<li><a href="#menu">Menu</a></li>
</ul>
</nav>
</div>
</header>
<!-- Menu -->
<nav id="menu">
<h2>Menu</h2>
<ul>
<li><a href="index.html">Home</a></li>
<li><a href="resource_menu.html">Resources</a></li>
<li><a href="https://sopkoc.wixsite.com/neuronest/forum">Ask a Question</a></li>
<li><a href="https://sopkoc.wixsite.com/neuronest/about">About NeuroNest</a></li>
<li><a href="https://sopkoc.wixsite.com/neuronest/contact">Contact</a></li>
</ul>
</nav>
<!-- Main -->
<div id="main">
<div class="inner">
<body>
<h1>Using GitHub Without the Command Line</h1>
<h2>Introduction</h2>
<p>GitHub is a platform used by developers, engineers, and designers worldwide to collaborate and share code. This guide will help you learn to use GitHub without needing to touch the command line. You will learn to:</p>
<ul>
<li>Create an account on GitHub.com</li>
<li>Create a repository</li>
<li>Manage and create branches</li>
<li>Commit changes to a repository</li>
<li>Open and merge pull requests</li>
<li>Create mentions and discussion</li>
</ul>
<div class="glossary">
<h2>Glossary of Key GitHub Terms</h2>
<ul>
<li><strong>Repository (Repo)</strong>: A container for organizing a project, including all of the project’s files and their revision history.</li>
<li><strong>Branch</strong>: A parallel version of a repository. It diverges from the main working project to work on changes separately until they're ready to be merged back.</li>
<li><strong>Commit</strong>: A snapshot of changes made to files in a repository. Each commit has a unique ID and a message describing the changes.</li>
<li><strong>Pull Request (PR)</strong>: A request to merge changes from one branch into another. It allows for code review and discussion before merging.</li>
<li><strong>Merge</strong>: Combining changes from different branches into one branch.</li>
<li><strong>README.md</strong>: A markdown file typically included in repositories to provide information about the project.</li>
<li><strong>Markdown</strong>: A lightweight markup language with plain text formatting syntax, often used for README files.</li>
</ul>
</div>
<h2>1. Create a GitHub Account</h2>
<ol>
<li>Visit <a href="https://github.com" target="_blank">GitHub.com</a>.</li>
<li>Pick a username, enter your email address, and choose a password.</li>
<li>Follow the prompts to complete the account setup.</li>
</ol>
<h2>2. Create a Repository</h2>
<ol>
<li>Click the "+" sign next to your avatar in the top right corner and select "New repository."</li> <img src="images/github_new_repo.png" alt="Create a New Repository" style="width: 30%;">
<li>Name your repository <code>hello-world</code>.</li>
<li>Write a short description of your project.</li>
<li>Select "Public."</li>
<li>Select "Initialize this repository with a README."</li>
<li>Click "Create repository."</li>
</ol>
<img src="images/github_repo_setup.png" alt="Setup New Repository" style="width: 65%;">
<h2>Step 3. Create a New Branch</h2>
<ol>
<li>In your <code>hello-world</code> repository, click the "branch" button.</li><img src="images/github_new_branch.png" alt="Create a New Branch" style="width: 25%;">
<li>Click the large green button that says "New Branch"</li> <img src="images/github_newbranch_button.png" alt="New Branch Button" style="width: 45%;">
<li>Type a branch name, e.g., <code>readme-edits</code>.</li>
<li>Click "Create branch"</li>
</ol>
<img src="images/github_newbranch_readme-edits.png" alt="Creating Branch named 'readme-edits'" style="width: 45%;">
<p></p><h3>Understanding Branching</h3>
<p>Branching involves diverging from your main line of development and continuing to work without affecting that main line. When you initialize a new Git repository, by default you’re checked into the main branch. Branching can be a great way of working on a feature of a project without affecting the main code. When you have finished working on your new feature you can then merge your new code into the main codebase, the main branch.</p>
<pre>
main
|
+--- development
</pre>
<p>After multiple changes, the development branch is then merged back into the main branch.</p>
<h2>4. Make Changes and Commit Them to the Repository</h2>
<ol>
<li>Ensure you are in the <code>readme-edits</code> branch.</li>
<li>Click on the <code>README.md</code> file.</li>
<li>Click the pencil icon to edit the file.</li>
<li>Add some text to the file.</li>
<li>Write a commit message describing your changes.</li>
<li>Click "Commit changes."</li> <img src="images/github_new_repo.png" alt="Create a New Repository" style="width: 25%;">
<li><i>Hint: If you don't see your changes check to make sure you are following markdown formatting.</i></li>
</ol>
<img src="images/github_edit_branch_commit.png" alt="Make Changes to File and Commit Them" style="width: 65%;">
<p></p><h3>Understanding Commits</h3>
<p>When a change is made, these changes are saved as commits. Each time you commit it is a good idea to add a short commit message. This creates a readable history of the project and allows others who may be contributing to the project to understand what is going on at a glance.</p>
<h2>5. Open a Pull Request and Merge Changes</h2>
<ol>
<li>Click the "Pull requests" tab.</li>
<li>Click "New pull request."</li>
<li>Select <code>readme-edits</code> to compare with <code>main</code>.</li>
<li>Review the changes and click "Create pull request."</li>
<li>Write a description of your changes.</li>
<li>Click "Create pull request."</li>
<li>Click "Merge pull request."</li>
<img src="images/github_merge_PR.png" alt="Merge Pull Request" style="width: 25%;">
<li>Click "Confirm merge."</li>
<li>Optionally, delete the <code>readme-edits</code> branch if no longer needed. This is good practice to delete the branch when you are done with it.</li>
</ol>
<img src="images/github_branch_pr.png" alt="Open a Pull Request for a Branch" style="width: 65%;">
<img src="images/github_pull_request.png" alt="Open a Pull Request" style="width: 65%;">
<p></p><h3>Understanding Pull Requests</h3>
<p>Pull Requests are what makes GitHub such a great tool for collaboration. At this point, we have made changes to a file ourselves, but in theory, anybody could make these changes and then ask for a Pull Request, allowing their edits to be merged into a project. A Pull Request needs to be reviewed before the changes are merged; this prevents bad work from entering a branch.</p>
<p>A Pull Request will highlight the differences (often called Diffs) in the content between branches. Changes can be additions or subtractions to the content. Additions are highlighted in green while subtractions are highlighted in red.</p>
<h2>6. Create Mentions and Discussion</h2>
<ol>
<li>In a pull request, use the <code>@</code> symbol followed by a username to mention a collaborator.</li>
<li>This can flag issues or invite discussion on specific changes.</li>
</ol>
<h3>More on Mentions & Discussions</h3>
<p>Mentions are a powerful way to bring specific people's attention to a pull request, issue, or comment. By using <code>@username</code>, you can notify a team member about something that needs their review or input. This is especially useful for highlighting issues, assigning tasks, or simply ensuring that someone is aware of a particular discussion.</p>
<p>In addition to mentions, GitHub provides a platform for discussion where collaborators can comment on pull requests and commits. This fosters a collaborative environment where feedback can be given, questions can be asked, and ideas can be shared. Keeping discussions in pull requests and issues helps maintain a clear history of decisions and changes related to the project.</p>
<h2>7. Conclusion</h2>
<p>By completing this tutorial, you've learned to:</p>
<ul>
<li>Create a repository.</li>
<li>Start and manage a new branch.</li>
<li>Make and commit changes.</li>
<li>Open and merge a pull request.</li>
<li>Create mentions and discussions.</li>
</ul>
<p>Next, you can explore more advanced features of GitHub or personalize your profile. Happy coding!</p>
<h2>Additional Resources</h2>
<ul>
<li><a href="https://swcarpentry.github.io/git-novice/aio.html" target="_blank">Software Carpentry, Version Control with Git (Command Line)</a></li>
</ul>
<h2>References</h2>
<ul>
<li><a href="https://pixelpioneers.co/blog/2017/using-github-without-the-command-line" target="_blank">Using GitHub Without The Command Line</a></li>
<li><a href="https://docs.github.com/en/get-started/start-your-journey/hello-world" target="_blank">Github Hello World Tutorial</a></li>
</ul>
</body>
</div>
</div>
<!-- Footer -->
<footer id="footer">
<div class="inner">
<section>
<h2>Funding</h2>
<p> We would like to express our heartfelt gratitude to <strong>Neurohackademy</strong> at the <strong>University of Washington eScience Institute</strong> for providing invaluable training and support. This experience has significantly enriched our understanding of neuroimaging and data science. We also acknowledge the support of the National Institute of Mental Health (NIMH) grant number <strong>5R25MH112480-08</strong>, which made this opportunity possible.</p>
</section>
<section>
<h2>Follow</h2>
<ul class="icons">
<li><a href="https://x.com/Neuro_Nest" class="icon brands style2 fa-twitter"><span class="label">Twitter</span></a></li>
<li><a href="https://github.com/NeuroHackademy2024/NeuroNest" class="icon brands style2 fa-github"><span class="label">GitHub</span></a></li>
<li><a href="https://sopkoc.wixsite.com/neuronest/contact" class="icon solid style2 fa-envelope"><span class="label">Email</span></a></li>
</ul>
</section>
<ul class="copyright">
<li>© Untitled. All rights reserved</li><li>Design: <a href="http://html5up.net">HTML5 UP</a></li>
</ul>
</div>
</footer>
</div>
<!-- Scripts -->
<script src="assets/js/jquery.min.js"></script>
<script src="assets/js/browser.min.js"></script>
<script src="assets/js/breakpoints.min.js"></script>
<script src="assets/js/util.js"></script>
<script src="assets/js/main.js"></script>
</body>
</html>