Built site for gh-pages

UCSB-Library-Research-Data-Services · Sep 6, 2024 · b377a5c · b377a5c
1 parent 3fd535d
commit b377a5c
Show file tree

Hide file tree

Showing 34 changed files with 767 additions and 723 deletions.
diff --git a/.nojekyll b/.nojekyll
@@ -1 +1 @@
-98f29f00
+46bb4301
diff --git a/01-handson_github_website.html b/01-handson_github_website.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/02-handson_github_rstudio.html b/02-handson_github_rstudio.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/03-handson_github_workflows.html b/03-handson_github_workflows.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/about.html b/about.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/coding.html b/coding.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/collab_exchange.html b/collab_exchange.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 
@@ -372,7 +372,14 @@
     <h2 id="toc-title">On this page</h2>
 
   <ul>
-  <li><a href="#pull-request-pr" id="toc-pull-request-pr" class="nav-link active" data-scroll-target="#pull-request-pr">Pull Request (PR)</a></li>
+  <li><a href="#how-to-conduct-a-code-exchange" id="toc-how-to-conduct-a-code-exchange" class="nav-link active" data-scroll-target="#how-to-conduct-a-code-exchange">How to conduct a code exchange</a>
+  <ul class="collapse">
+  <li><a href="#asynchronous-or-synchronous" id="toc-asynchronous-or-synchronous" class="nav-link" data-scroll-target="#asynchronous-or-synchronous">Asynchronous or synchronous</a></li>
+  </ul></li>
+  <li><a href="#pull-request-pr" id="toc-pull-request-pr" class="nav-link" data-scroll-target="#pull-request-pr">Pull Request (PR)</a>
+  <ul class="collapse">
+  <li><a href="#what-to-look-for-in-your-review" id="toc-what-to-look-for-in-your-review" class="nav-link" data-scroll-target="#what-to-look-for-in-your-review">What to look for in your review</a></li>
+  </ul></li>
   <li><a href="#recommended-reading" id="toc-recommended-reading" class="nav-link" data-scroll-target="#recommended-reading">Recommended Reading</a></li>
   </ul>
 </nav>
@@ -405,18 +412,43 @@ <h1 class="title">Code <del>Review</del> <em>Exchange</em></h1>
 <li>Motivate development of good documentation</li>
 <li><strong>Generate conversation about code styling</strong></li>
 <li>Have several team members sharing knowledge</li>
-<li>Great way to onboard new team members both in terms of code knowledge but also code styling</li>
+<li>Great way to onboard new team members both in terms of code knowledge and code styling</li>
 </ul>
-<p>The Reviewer should see this activity as a great way to learn from others through <strong>constructive</strong> feedback… and so should the Submitter!!</p>
-<p>There are different way to conduct a code review. It ranges from asking a colleague to look at your code once you reached a milestone, for example a new analysis is working, to leveraging Pull Request (PR), which is a way to ask to merge your changes with the previous version.</p>
+<p>The Submitter should see this activity as a great way to learn from others through <strong>constructive</strong> feedback… and so should the Reviewer!! This is why we prefer using the term code exchange instead of the usual code review. In some way, since scientists are well used to getting their work reviewed by peers, this process should feel familiar. Generally, when your code reaches a milestone (like finalizing a new analysis or figure), it is a good time to request a code review.</p>
+<section id="how-to-conduct-a-code-exchange" class="level2">
+<h2 class="anchored" data-anchor-id="how-to-conduct-a-code-exchange">How to conduct a code exchange</h2>
+<section id="asynchronous-or-synchronous" class="level3">
+<h3 class="anchored" data-anchor-id="asynchronous-or-synchronous">Asynchronous or synchronous</h3>
+<p>There are different ways to conduct code review. Here are a few examples inspired by Petre and Wilson (2014):</p>
+<ul>
+<li>Asynchronous: The submitter use GitHub or other code repository platform to request review of their code, assigning a teammate. The teammate will look at the code on their own and use the platform to provide written comments</li>
+<li>Synchronous: Involve meeting (in-person or remotely) to talk over the code details. The Submitter will walk the Reviewer through the code. This can also work as a small team.</li>
+</ul>
+<p>Of course you can also blend the two methods with scheduling a meeting once the Reviewer has done a fist pass at the code and has a first series of questions.</p>
+<ul>
+<li>Asynchronous: The submitter uses GitHub or another code repository platform to request a review of their code, assigning a teammate. The teammate will look at the code on their own and use the platform to provide written comments</li>
+<li>Synchronous: Involve meeting (in-person or remotely) to talk over the code details. The Submitter will walk the Reviewer through the code. This can also work as a small team.</li>
+</ul>
+<p>Of course, you can also blend the two methods with scheduling a meeting once the Reviewer has done a first pass at the code and has a first series of questions.</p>
+<p>As you are building your code review skills, we recommend organizing a meeting to walk through the code and have a discussion about the content. It maximizes the learning experience and is also a great team-building exercise. Some research labs even organize lab meetings for code (see <a href="https://web.archive.org/web/20170701202441/http:/fperez.org/py4science/code_reviews.html">here</a> for more)</p>
+<p>Synchronous or not, we recommend leveraging Pull Request (PR), which is a GitHub way to request to merge your changes with the current repository version, to create a written trace of the discussion and comments you will be exchanging through the process. So if six months after the review you wonder why you ended up opting for some of those changes you can refer to it to refresh yourself with the rationale at the time of the review.</p>
+</section>
+</section>
 <section id="pull-request-pr" class="level2">
 <h2 class="anchored" data-anchor-id="pull-request-pr">Pull Request (PR)</h2>
 <p>A big advantage of Pull Request is to document and provide a space to discuss the new code and discuss potential modifications. You can even tag others if you want them to chime in.</p>
 <p>To be able to create a PR, you need to first either create a branch or a fork, which are two ways to encapsulate your changes while you are working on them. Once you are done you can ask to send back and merge those changes to the current version of the main branch of the repository (for now we will only merge back to main).</p>
+<section id="what-to-look-for-in-your-review" class="level3">
+<h3 class="anchored" data-anchor-id="what-to-look-for-in-your-review">What to look for in your review</h3>
+</section>
 </section>
 <section id="recommended-reading" class="level2">
 <h2 class="anchored" data-anchor-id="recommended-reading">Recommended Reading</h2>
 <p>Ivimey-Cook ER, Pick JL, Bairos-Novak KR, Culina A, Gould E, Grainger M, et al.&nbsp;<em>Implementing code review in the scientific workflow: Insights from ecology and evolutionary biology.</em> Journal of Evolutionary Biology. 2023;36: 1347–1356. <a href="https://doi.org/10.1111/jeb.14230">doi:10.1111/jeb.14230</a></p>
+<p>Petre, M., Wilson, G., 2014. Code Review For and By Scientists. <a href="https://doi.org/10.48550/arXiv.1407.5648" class="uri">https://doi.org/10.48550/arXiv.1407.5648</a></p>
+<p>Rokem, A., 2024. Ten simple rules for scientific code review. PLoS Computational Biology 20(9): e1012375. <a href="https://doi.org/10.1371/journal.pcbi.1012375" class="uri">https://doi.org/10.1371/journal.pcbi.1012375</a></p>
+<p>Code reviews - the lab meeting for code: <a href="https://web.archive.org/web/20170701202441/http:/fperez.org/py4science/code_reviews.html" class="uri">https://web.archive.org/web/20170701202441/http:/fperez.org/py4science/code_reviews.html</a></p>
+<p>Small-Group Code Reviews For Education: <a href="https://cacm.acm.org/blogs/blog-cacm/175944-small-group-code-reviews-for-education/fulltext" class="uri">https://cacm.acm.org/blogs/blog-cacm/175944-small-group-code-reviews-for-education/fulltext</a></p>
 
 
 </section>

diff --git a/collab_pairprog.html b/collab_pairprog.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/data_mgmt.html b/data_mgmt.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/datamgmt_manage.html b/datamgmt_manage.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/datamgmt_plan.html b/datamgmt_plan.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/datamgmt_prompts.html b/datamgmt_prompts.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/git_cli.html b/git_cli.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/git_conflicts.html b/git_conflicts.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/git_further_readings.html b/git_further_readings.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/git_rstudio.html b/git_rstudio.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/github_intro.html b/github_intro.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/github_org.html b/github_org.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/github_teams.html b/github_teams.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/github_template.html b/github_template.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/github_workflows.html b/github_workflows.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/index.html b/index.html
@@ -2,14 +2,14 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 
 <meta name="author" content="Julien Brun">
 <meta name="author" content="Renata Curty">
 <meta name="author" content="Greg Janée">
-<meta name="dcterms.date" content="2024-08-20">
+<meta name="dcterms.date" content="2024-09-06">
 
 <title>Designing a Reproducible and Collaborative Lab (RCL)</title>
 <style>
@@ -412,7 +412,7 @@ <h1 class="title">Designing a Reproducible and Collaborative Lab (RCL)</h1>
     <div>
     <div class="quarto-title-meta-heading">Published</div>
     <div class="quarto-title-meta-contents">
-      <p class="date">August 20, 2024</p>
+      <p class="date">September 6, 2024</p>
     </div>
   </div>
 
@@ -476,13 +476,13 @@ <h3 class="anchored" data-anchor-id="want-to-know-more">Want to know more?</h3>
 <div id="quarto-appendix" class="default"><section class="quarto-appendix-contents" id="quarto-citation"><h2 class="anchored quarto-appendix-heading">Citation</h2><div><div class="quarto-appendix-secondary-label">BibTeX citation:</div><pre class="sourceCode code-with-copy quarto-appendix-bibtex"><code class="sourceCode bibtex">@online{brun2024,
   author = {Brun, Julien and Curty, Renata and Janée, Greg},
   title = {Designing a {Reproducible} and {Collaborative} {Lab} {(RCL)}},
-  date = {2024-08-20},
+  date = {2024-09-06},
   url = {https://ucsb-library-research-data-services.github.io/reproducible-lab/},
   langid = {en}
 }
 </code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre><div class="quarto-appendix-secondary-label">For attribution, please cite this work as:</div><div id="ref-brun2024" class="csl-entry quarto-appendix-citeas" role="listitem">
 Brun, Julien, Renata Curty, and Greg Janée. 2024. <span>“Designing a
-Reproducible and Collaborative Lab (RCL).”</span> August 20, 2024. <a href="https://ucsb-library-research-data-services.github.io/reproducible-lab/">https://ucsb-library-research-data-services.github.io/reproducible-lab/</a>.
+Reproducible and Collaborative Lab (RCL).”</span> September 6, 2024. <a href="https://ucsb-library-research-data-services.github.io/reproducible-lab/">https://ucsb-library-research-data-services.github.io/reproducible-lab/</a>.
 </div></div></section></div></main> <!-- /main -->
 <div>
   <p></p><hr><p></p>

diff --git a/intro_cli.html b/intro_cli.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/preserve_code.html b/preserve_code.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/preserve_computing-env.html b/preserve_computing-env.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/preserve_data-fair.html b/preserve_data-fair.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/preserve_data.html b/preserve_data.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/preserve_license.html b/preserve_license.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/preserve_prompts.html b/preserve_prompts.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/preserve_readme.html b/preserve_readme.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/preserve_self.html b/preserve_self.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.56">
+<meta name="generator" content="quarto-1.5.57">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">