forked from RVerse-Tutorials/RWorkflow-NWFSC-2021
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathweek7-more-git.html
690 lines (591 loc) · 23.9 KB
/
week7-more-git.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
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta http-equiv="X-UA-Compatible" content="IE=EDGE" />
<title>Week 7: More Git</title>
<script src="site_libs/header-attrs-2.9/header-attrs.js"></script>
<script src="site_libs/jquery-1.11.3/jquery.min.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link href="site_libs/bootstrap-3.3.5/css/readable.min.css" rel="stylesheet" />
<script src="site_libs/bootstrap-3.3.5/js/bootstrap.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/html5shiv.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/respond.min.js"></script>
<style>h1 {font-size: 34px;}
h1.title {font-size: 38px;}
h2 {font-size: 30px;}
h3 {font-size: 24px;}
h4 {font-size: 18px;}
h5 {font-size: 16px;}
h6 {font-size: 12px;}
code {color: inherit; background-color: rgba(0, 0, 0, 0.04);}
pre:not([class]) { background-color: white }</style>
<script src="site_libs/jqueryui-1.11.4/jquery-ui.min.js"></script>
<link href="site_libs/tocify-1.9.1/jquery.tocify.css" rel="stylesheet" />
<script src="site_libs/tocify-1.9.1/jquery.tocify.js"></script>
<script src="site_libs/navigation-1.1/tabsets.js"></script>
<link href="site_libs/highlightjs-9.12.0/textmate.css" rel="stylesheet" />
<script src="site_libs/highlightjs-9.12.0/highlight.js"></script>
<script src="site_libs/kePrint-0.0.1/kePrint.js"></script>
<link href="site_libs/lightable-0.0.1/lightable.css" rel="stylesheet" />
<link href="site_libs/font-awesome-5.1.0/css/all.css" rel="stylesheet" />
<link href="site_libs/font-awesome-5.1.0/css/v4-shims.css" rel="stylesheet" />
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<style type="text/css">
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
</style>
<style type="text/css">code{white-space: pre;}</style>
<script type="text/javascript">
if (window.hljs) {
hljs.configure({languages: []});
hljs.initHighlightingOnLoad();
if (document.readyState && document.readyState === "complete") {
window.setTimeout(function() { hljs.initHighlighting(); }, 0);
}
}
</script>
<link rel="stylesheet" href="styles.css" type="text/css" />
<style type = "text/css">
.main-container {
max-width: 940px;
margin-left: auto;
margin-right: auto;
}
img {
max-width:100%;
}
.tabbed-pane {
padding-top: 12px;
}
.html-widget {
margin-bottom: 20px;
}
button.code-folding-btn:focus {
outline: none;
}
summary {
display: list-item;
}
pre code {
padding: 0;
}
</style>
<style type="text/css">
.dropdown-submenu {
position: relative;
}
.dropdown-submenu>.dropdown-menu {
top: 0;
left: 100%;
margin-top: -6px;
margin-left: -1px;
border-radius: 0 6px 6px 6px;
}
.dropdown-submenu:hover>.dropdown-menu {
display: block;
}
.dropdown-submenu>a:after {
display: block;
content: " ";
float: right;
width: 0;
height: 0;
border-color: transparent;
border-style: solid;
border-width: 5px 0 5px 5px;
border-left-color: #cccccc;
margin-top: 5px;
margin-right: -10px;
}
.dropdown-submenu:hover>a:after {
border-left-color: #adb5bd;
}
.dropdown-submenu.pull-left {
float: none;
}
.dropdown-submenu.pull-left>.dropdown-menu {
left: -100%;
margin-left: 10px;
border-radius: 6px 0 6px 6px;
}
</style>
<script type="text/javascript">
// manage active state of menu based on current page
$(document).ready(function () {
// active menu anchor
href = window.location.pathname
href = href.substr(href.lastIndexOf('/') + 1)
if (href === "")
href = "index.html";
var menuAnchor = $('a[href="' + href + '"]');
// mark it active
menuAnchor.tab('show');
// if it's got a parent navbar menu mark it active as well
menuAnchor.closest('li.dropdown').addClass('active');
// Navbar adjustments
var navHeight = $(".navbar").first().height() + 15;
var style = document.createElement('style');
var pt = "padding-top: " + navHeight + "px; ";
var mt = "margin-top: -" + navHeight + "px; ";
var css = "";
// offset scroll position for anchor links (for fixed navbar)
for (var i = 1; i <= 6; i++) {
css += ".section h" + i + "{ " + pt + mt + "}\n";
}
style.innerHTML = "body {" + pt + "padding-bottom: 40px; }\n" + css;
document.head.appendChild(style);
});
</script>
<!-- tabsets -->
<style type="text/css">
.tabset-dropdown > .nav-tabs {
display: inline-table;
max-height: 500px;
min-height: 44px;
overflow-y: auto;
border: 1px solid #ddd;
border-radius: 4px;
}
.tabset-dropdown > .nav-tabs > li.active:before {
content: "";
font-family: 'Glyphicons Halflings';
display: inline-block;
padding: 10px;
border-right: 1px solid #ddd;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open > li.active:before {
content: "";
border: none;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open:before {
content: "";
font-family: 'Glyphicons Halflings';
display: inline-block;
padding: 10px;
border-right: 1px solid #ddd;
}
.tabset-dropdown > .nav-tabs > li.active {
display: block;
}
.tabset-dropdown > .nav-tabs > li > a,
.tabset-dropdown > .nav-tabs > li > a:focus,
.tabset-dropdown > .nav-tabs > li > a:hover {
border: none;
display: inline-block;
border-radius: 4px;
background-color: transparent;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open > li {
display: block;
float: none;
}
.tabset-dropdown > .nav-tabs > li {
display: none;
}
</style>
<!-- code folding -->
<style type="text/css">
#TOC {
margin: 25px 0px 20px 0px;
}
@media (max-width: 768px) {
#TOC {
position: relative;
width: 100%;
}
}
@media print {
.toc-content {
/* see https://github.com/w3c/csswg-drafts/issues/4434 */
float: right;
}
}
.toc-content {
padding-left: 30px;
padding-right: 40px;
}
div.main-container {
max-width: 1200px;
}
div.tocify {
width: 20%;
max-width: 260px;
max-height: 85%;
}
@media (min-width: 768px) and (max-width: 991px) {
div.tocify {
width: 25%;
}
}
@media (max-width: 767px) {
div.tocify {
width: 100%;
max-width: none;
}
}
.tocify ul, .tocify li {
line-height: 20px;
}
.tocify-subheader .tocify-item {
font-size: 0.90em;
}
.tocify .list-group-item {
border-radius: 0px;
}
.tocify-subheader {
display: inline;
}
.tocify-subheader .tocify-item {
font-size: 0.95em;
}
</style>
</head>
<body>
<div class="container-fluid main-container">
<!-- setup 3col/9col grid for toc_float and main content -->
<div class="row">
<div class="col-xs-12 col-sm-4 col-md-3">
<div id="TOC" class="tocify">
</div>
</div>
<div class="toc-content col-xs-12 col-sm-8 col-md-9">
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">RWorkflow</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="set-up.html">
<span class="fa fa-clone"></span>
Set-up
</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
<span class="fa fa-calendar"></span>
Workshop Weekly Notes
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="week1.html">
<span class="fa fa-cogs"></span>
Week 1 RStudio + Version Control
</a>
</li>
<li>
<a href="week2.html">
<span class="fa fa-gitalt"></span>
Week 2 More Git/GitHub
</a>
</li>
<li>
<a href="week3.html">
<span class="fab fa-github"></span>
Week 3 GitHub
</a>
</li>
</ul>
</li>
<li>
<a href="https://rverse-tutorials.github.io/RWorkflow/">
<span class="fa fa-folder"></span>
Archive
</a>
</li>
<li>
<a href="https://rverse-tutorials.github.io/RWorkflow-NWFSC-2020">
<span class="fa fa-clock"></span>
2020 website
</a>
</li>
<li>
<a href="links.html">
<span class="fa fa-info"></span>
More resources
</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/RVerse-Tutorials/RWorkflow-NWFSC-2021">
<span class="fab fa-github"></span>
Repo
</a>
</li>
<li>
<a href="https://github.com/orgs/RWorkflow-Workshop-2021">Org</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
<div id="header">
<h1 class="title toc-ignore">Week 7: More Git</h1>
</div>
<table class="table" style="margin-left: auto; margin-right: auto;">
<tbody>
<tr>
<td style="text-align:left;color: white !important;background-color: blue !important;width: 20%; ">
Compartmentalized
</td>
<td style="text-align:left;color: white !important;background-color: blue !important;width: 20%; ">
Documented
</td>
<td style="text-align:left;color: white !important;background-color: blue !important;width: 20%; ">
Extendible
</td>
<td style="text-align:left;color: white !important;background-color: blue !important;width: 20%; ">
Reproducible
</td>
<td style="text-align:left;color: white !important;background-color: blue !important;width: 20%; ">
Robust
</td>
</tr>
</tbody>
</table>
<p>This week I will cover some more features of using Git, GitHub, and RStudio. Although I’ll be using GitHub, the same workflow applies to GitLab. I am going to be using GitHub Desktop to interact with GitHub since I find that GitHub Desktop helps me deal with merge conflicts and reverts (getting rid of changes I have made).</p>
<ul>
<li>What’s a merge conflict and how to fix it</li>
<li>How to use branches</li>
<li>How to do a pull request to pull a branch into your master repository</li>
<li>How to ‘go back in time’ and get rid of changes</li>
<li>Working with issues in GitHub</li>
<li>How to create a release in GitHub</li>
<li>A workflow to minimize headaches</li>
</ul>
<p>I’ll be illustrating this with this repo: <a href="https://github.com/eeholmes/MyNewPackage" class="uri">https://github.com/eeholmes/MyNewPackage</a> You can see a real-world example of this here on my MARSS package repo: <a href="https://github.com/nwfsc-timeseries/MARSS" class="uri">https://github.com/nwfsc-timeseries/MARSS</a></p>
<div id="merge-conflicts" class="section level2">
<h2>Merge conflicts</h2>
<p>Merge conflicts happen when there are changes to a file on your remote repository (GitHub or GitLab) but also changes to that same file on your local repository. Git doesn’t know how to resolve the conflicting changes and needs your help.</p>
<div id="resolving-these-with-github-desktop" class="section level3">
<h3>Resolving these with GitHub Desktop</h3>
<p>GitHub Desktop makes resolving these pretty easy.</p>
<ol style="list-style-type: decimal">
<li>If it tells you to fetch commits off GitHub, go ahead and do that.</li>
<li>Now try to Pull. It’ll tell you that you have conflicts and give you options for what to do.</li>
</ol>
<div class="figure">
<img src="images/git-merge-conflict-gh.png" alt="" />
<p class="caption">GitHub Desktop merge conflict alert</p>
</div>
<ul>
<li>Click the ‘x’ and Git will alter <code>hello.R</code> and show where the conflicts are. You then edit <code>hello.R</code> in RStudio to fix the conflicts.</li>
<li>If you know what file you want to use, use the little arrow dropdown to use the file on GitHub or on your local machine.</li>
<li>Use Abort Merge to abandon the merge. Your changes to <code>hello.R</code> are still there.
<ul>
<li>Click on History, right click the commit and revert to get rid of it. All file changes that are part of that commit will disappear! You can revert the revert if needed.</li>
<li>Go into <code>hello.R</code> and fix the conflict. Git won’t have marked it so it might be hard to find.</li>
</ul></li>
</ul>
</div>
<div id="resolving-these-with-git-in-rstudio" class="section level3">
<h3>Resolving these with Git in RStudio</h3>
<p>Unfortunately, when you hit ‘Push’ in the Git tab in RStudio, it will immediately change <code>hello.R</code> with the conflicts. RStudio won’t give you the chance to abandon the merge or pick one of the files.</p>
<p>But you can fix and then merge.</p>
<ul>
<li>Open <code>hello.R</code> and get rid of all the merge conflict code (denoted with the ============ and >>>>>>>>>>>>>>>>).</li>
<li>The file will appear in the Git tab.</li>
<li>Click on the checkbox until a CHECK appears. Filled in square is not enough. You need the CHECK.</li>
<li>Commit the change.</li>
<li>Push.</li>
</ul>
</div>
</div>
<div id="working-with-branches" class="section level2">
<h2>Working with branches</h2>
<p>Why use branches?</p>
<ul>
<li>Let’s say you have a function that works fine and you want to make a bunch of changes but don’t want to break the old version. Work on a branch to sandbox your changes and merge back into master when done.</li>
<li>Let’s say you want to try out an idea or new feature. Develop on a branch and merge into master when done.</li>
<li>Let’s say you want to do a major revamp of your code, but you are worried that you might want to abandon this. Work on a branch. If you decide against the change, you just delete the branch.</li>
<li>Will your work break code? Make a branch.</li>
</ul>
<p>When you start, keep it simple. Use a branch for one file or two. Work on the file and then merge it back into master. Then get rid of the branch. It’s not necessary to use branches but if you do a lot of coding or work on packages, then getting comfortable with them will help you out.</p>
<div id="make-a-new-branch-in-rstudio" class="section level3">
<h3>Make a new branch in RStudio</h3>
<p>Click the new branch icon and give your branch a name. Give it an INFORMATIVE name. <code>tmp</code>, <code>foo</code> are bad. <code>hello_branch</code> is good as it tells what this branch is for (working on the <code>hello.R</code> file). <img src="images/new-branch.png" alt="new branch" /></p>
<p>Now that you have a branch, it is critical that you pay attention to the Git tab and know where you are working. RStudio will remember what branch you are on.</p>
<p>Let’s make a change to <code>hello.R</code> on hello_branch, put to GitHub and see what the two branches look like.</p>
</div>
<div id="pull-request-merge-our-branch-with-master" class="section level3">
<h3>Pull request, merge our branch with master</h3>
<p>There are a few ways to do a pull request.</p>
<ul>
<li><p>You can do it from GitHub Desktop. It’ll just redirect you to GitHub however.</p></li>
<li><p>You can do it from GitHub.</p></li>
</ul>
<div class="figure">
<img src="images/pull-request-github.png" alt="" />
<p class="caption">pull request from GitHub</p>
</div>
<pre><code>Once you have created the pull requests, you'll see that the pull request tab (in GitHub) shows that there is a request.</code></pre>
<ul>
<li><p>Click on the request. You have 2 options.</p>
<ul>
<li>Close it (don’t merge). If you close it, you can reopen it later.</li>
<li>Merge the request.</li>
</ul></li>
<li><p>You have done the merge on GitHub. You still need to do a Pull to get that change into your local repository.</p></li>
<li><p>Delete your branch when you are done with it. All the history is saved. There is no reason keep branches that you are done with.</p></li>
</ul>
</div>
<div id="branch-actions-from-github-desktop" class="section level3">
<h3>Branch actions from GitHub Desktop</h3>
<p>The branch toolbar in GitHub Desktop let’s keep branches up to date with each other.</p>
<p>Let’s say I am working on <code>littleforecast.R</code> in the master branch while working on <code>hello.R</code> in the hello_branch. I want to keep these synced up.</p>
<ul>
<li><strong>Compare</strong> I can compare branches and look at the differences.</li>
<li><strong>Merge into current branch</strong> I can merge changes from one branch into another branch. It will let you see the changes before you decide to merge.</li>
<li><strong>Update from master</strong> This immediately merge changes from master into your branch. It won’t ask you. So you need to revert the change if you don’t like it.</li>
</ul>
<p>This is similar to a pull request but happening locally. When a team is working on different branches, they would use pull requests.</p>
</div>
<div id="branch-actions-from-github" class="section level3">
<h3>Branch actions from GitHub</h3>
<p>You can do the same actions from GitHub.</p>
</div>
</div>
<div id="issues" class="section level2">
<h2>Issues</h2>
<ul>
<li>Use the Issues in GitHub to enter any issues (bugs, feature changes, notes).</li>
<li>You can reference issues in your commits with #<num of the issue></li>
<li>Add code to your issue so you can easily recreate the problem</li>
</ul>
</div>
<div id="releases" class="section level2">
<h2>Releases</h2>
<ul>
<li>The release or tag feature in GitHub will help you go back in time and document working states</li>
<li>Use a NEWS file to keep a notebook of all your changes. I use a standard format with BUGS, DOCUMENTATION, ENHANCEMENTS. It’s really helpful for understanding what is happening with the code.</li>
</ul>
</div>
<div id="getting-rid-of-changes-you-have-made" class="section level2">
<h2>Getting rid of changes you have made</h2>
<p>Say you made a change and you need to get rid of that. The temptation (for me) is to jump onto the Git command line and clobber my repository with <code>reset</code> and <code>revert</code> commands. Don’t do this. Here are some strategies that will make this let prone to leaving your code a mess.</p>
<div id="have-you-commited-the-changes-yet" class="section level3">
<h3>Have you commited the changes yet?</h3>
<p><strong>No?</strong> Easy click on the file in the Git panel in RStudio, right click, and click ‘Revert’. Note this will take things all the way back to your last commit!! If you have been making a bunch of changes without committing those, then you are out of luck.</p>
<p><strong>Yes?</strong> Go to History in the GitHub Desktop window, click on the commit and click ‘Revert’. This will get rid of all the changes that went with that commit. So if you changed multiple files, all those files will be reverted. If you have pushed the changes to GitHub, then you can push the revert and it’ll show up on GitHub too.</p>
<p><strong>Yes but you just want to revert one file in a multi-file commit?</strong> Ok, you can do this at the Git command line, but I find that to be a huge time suck and in my early Git days, I sometimes left my repository with a horrible problem that I could not fix and had to completely rebuild my repo. Since I don’t need to be a Git wizard, this is what I do when I want to go ‘back in time’ for a since file.</p>
<p>Assuming you have already pushed the changes up to GitHub</p>
<ul>
<li>Go to the repo on GitHub</li>
<li>Click ‘commits’ It’s a little icon above your code with a clock with a counter-clockwise arrow.</li>
<li>Scroll to the commit where the file was in the state you want (one before the last bad commit).</li>
<li>On the right click the <code>< ></code> to browse your repo at the state in time where your file was ok.</li>
<li>Click on the file and copy the text.</li>
<li>Go back to RStudio, open the file, and paste in the text from when it was good.</li>
</ul>
<p>If you have not pushed the changes up to GitHub.</p>
<ul>
<li>Now you have to go to the Git command line. Git tab in RStudio and then click the cog > Shell.</li>
<li>Note, in 9 times out of 10, I would push the commit to GitHub and then use the above copy/paste to avoid using the Git command line. I would find that much faster.</li>
</ul>
<p>Ok, here’s the Git command to get a single file back. This works whether or not you have pushed to GitHub. The problem with this and why I don’t do it is that I usually need to look at the file. So I am scrolling back through the status of my repo in the past until I find the status that I want. Then I stare a bit and think and think. Then get a coffee and think some more. Then I scroll back through the status of the repo in the past some more and THEN I do the copy and paste. It is rarely the case that I know exactly what commit that I need to get rid of—and even rarer that I want to go completely to a status in the past.</p>
<ul>
<li>Open the Git bash shell</li>
<li><code>git log</code> to find the commit hash (the long number)</li>
<li><code>git checkout 1d0f8c2eb4e66db0a7123588ae2fad26a6338303~1 -- ./R/test.R</code> would reset test.R to one before that commit. This part <code>1d0f8c2eb4e66db0a7123588ae2fad26a6338303</code> is the bad commit hash and this part <code>~1</code> means what the file was like 1 commit before that.</li>
</ul>
<p>If you accidentally leave off the file name and Git says you have a detached head, use <code>git checkout master</code> to reattach your head.</p>
</div>
</div>
<div id="a-workflow-to-minimize-headaches" class="section level2">
<h2>A workflow to minimize headaches</h2>
<div id="starting-out" class="section level3">
<h3>Starting out</h3>
<ul>
<li>Don’t use branches when you are just starting. Get used to committing and pulling without creating merge conflicts.</li>
<li>Get in the habit of always doing a Pull/Push before you start work in your project.</li>
</ul>
</div>
<div id="once-you-are-experienced-with-github" class="section level3">
<h3>Once you are experienced with GitHub</h3>
<p>Once doing commits and push/pulls is familiar and you are no longer messing up your repository or making merge conflicts,</p>
<ul>
<li>Start using branches</li>
<li>Work on one branch at a time</li>
<li>Delete your branch when done</li>
<li>Once you start using multiple branches, be careful to keep them separate. Modifications to <code>file_xyz</code> should only be in one branch.</li>
</ul>
</div>
</div>
<hr>
<div style="text-align: center">
<i class="fas fa-cubes"></i> NWFSC Math Bio Program <i class="fas fa-cubes"></i>
</div>
</div>
</div>
</div>
<script>
// add bootstrap table styles to pandoc tables
function bootstrapStylePandocTables() {
$('tr.odd').parent('tbody').parent('table').addClass('table table-condensed');
}
$(document).ready(function () {
bootstrapStylePandocTables();
});
</script>
<!-- tabsets -->
<script>
$(document).ready(function () {
window.buildTabsets("TOC");
});
$(document).ready(function () {
$('.tabset-dropdown > .nav-tabs > li').click(function () {
$(this).parent().toggleClass('nav-tabs-open');
});
});
</script>
<!-- code folding -->
<script>
$(document).ready(function () {
// temporarily add toc-ignore selector to headers for the consistency with Pandoc
$('.unlisted.unnumbered').addClass('toc-ignore')
// move toc-ignore selectors from section div to header
$('div.section.toc-ignore')
.removeClass('toc-ignore')
.children('h1,h2,h3,h4,h5').addClass('toc-ignore');
// establish options
var options = {
selectors: "h1,h2",
theme: "bootstrap3",
context: '.toc-content',
hashGenerator: function (text) {
return text.replace(/[.\\/?&!#<>]/g, '').replace(/\s/g, '_');
},
ignoreSelector: ".toc-ignore",
scrollTo: 0
};
options.showAndHide = false;
options.smoothScroll = true;
// tocify
var toc = $("#TOC").tocify(options).data("toc-tocify");
});
</script>
<!-- dynamically load mathjax for compatibility with self-contained -->
<script>
(function () {
var script = document.createElement("script");
script.type = "text/javascript";
script.src = "https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";
document.getElementsByTagName("head")[0].appendChild(script);
})();
</script>
</body>
</html>