merged develop

Author: jdamerow

_posts/2022-11-18-code-review-malte.md

@@ -0,0 +1,17 @@
+---
+layout: post
+title:  "My code got reviewed and I liked it!"
+author: Malte Vogl
+date:   2022-10-18 15:19:03 -0400
+categories: jekyll update
+---
+
+In the DHtech Code Review Working Group, the chance arose to have a piece of code reviewed that I created for a research project dealing with knowledge networks, i.e. multilayer networks of people, material objects and representations of semantic concepts that can describe the spread of knowledge. At that time the code was written for my own use and I only collaborated with other scientists on the output of the code, i.e. CSV files or visualizations of networks.
+
+So having the actual code reviewed was on the one hand a bit scary since I had no experience with code review whatsoever, but on the other hand also absolutely necessary to judge the validity of it for the research questions at hand. What if I accidentally had some logical errors in the procedure which invalidated the results? Any comments from an external perspective could be really useful.
+
+So I decided to submit the code for review (through [this form](https://forms.gle/pBm2jUVqz65dPHi28))  and waited for reviewers to take up the process. The Code Review Working Group had some useful instructions on how to start the process and proceed, which are now bundled at [https://dhcodereview.github.io/](https://dhcodereview.github.io/). A few days later I checked the PR for the review and saw that the review was actually already done. I had simply forgotten to watch my own PR and was not notified of the comments. Something learned already. ;-)
+
+Reading the comments lead to a kind of internal two- way communication in my case. For each comment, I had to get the idea behind the comment, compare it with my coding reasons, and then see if I would agree with the change or not. In the end, I changed the code where necessary and commented on the changes in the review.
+
+Most of the comments were on improving the readability of the code and streamlining some procedures. In general I found the comments very useful and instructive for myself. With the focus on code quality, they definitely helped me get an outside perspective and thus hopefully helped to make the code more reusable. A detailed review of the algorithmical assumptions would have required more domain knowledge and time, and was thus out of scope, as the reviewer commented. Apart from my initial misunderstanding of the process of setting up notifications, the process was actually really quick and effective. So: 10/10 points, would do it again!

assets/css/site.css

@@ -1,14 +1,14 @@
 :root{
-  --bs-primary:#227e9d;
-  --bs-blue:#227e9d;
-  --bs-link-color:var(--bs-blue);
-  --bs-link-hover-color: #3494b4;
+  --bs-primary:##E36414;
+  --bs-blue:##E36414;
+  --bs-link-color:#e37c1c;
+  --bs-link-hover-color: #FB8B24;
 }
 .btn-primary {
-  --bs-btn-bg:var(--bs-primary);
-  --bs-btn-border-color:var(--bs-blue);
-  --bs-btn-hover-bg: #3494b4;
-  --bs-btn-hover-border-color: #3494b4;
+  --bs-btn-bg: #e37c1c;
+  --bs-btn-border-color:#e37c1c;
+  --bs-btn-hover-bg: #FB8B24;
+  --bs-btn-hover-border-color: #FB8B24;
 }
 
 .icon-list li::before {
@@ -21,3 +21,8 @@
     background: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='%23212529' viewBox='0 0 16 16'%3E%3Cpath d='M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0zM4.5 7.5a.5.5 0 0 0 0 1h5.793l-2.147 2.146a.5.5 0 0 0 .708.708l3-3a.5.5 0 0 0 0-.708l-3-3a.5.5 0 1 0-.708.708L10.293 7.5H4.5z'/%3E%3C/svg%3E") no-repeat center center / 100% auto;
   }
 
+  h1, h2, h3, h4, h5 {
+    color:#0F4C5C;
+  }
+
+

assets/files/DH2022-CodeReview-Poster.pdf

@@ -7,7 +7,7 @@
 
 
 <h1>Community Code Review</h1>
-    <p class="fs-5 col-md-8">Welcome to the website of the Community Code Review Working Group of DHTech! </p>
+    <p class="fs-5 col-md-8">Welcome to the website of the Community Code Review Working Group of <a href="https://dh-tech.github.io/">DHTech</a>! </p>
 
    <p>
       <i>Code review</i> is a widespread technique to improve software and reduce the number of flaws. In a code review, a programmer (other than the original code author(s)) reviews the source code. They ask questions and make suggestions for improving the software. In addition to identifying and eliminating errors, code review can improve overall quality by making the source code more readable and maintainable.</p>
@@ -53,6 +53,16 @@ <h2>Submission Deadlines</h2>
       &nbsp;
       <a href="https://forms.gle/PepxF6U64AT2Y5TZA" class="btn btn-primary btn-sm" type="submit">Become a Reviewer</a>
     </p>
+    <hr class="col-3 col-md-2 mb-5">
+    {% for post in site.posts limit:1 %}
+    <h2>{{ post.title}}</h2>
+    <p class="blogdate">{{ post.date | date: "%d %B %Y" }}</p>
+    <p>
+      {{ post.content|truncatewords:60 }}
+    </p>
+    <p style="text-align:right"><a href="{{ post.url }}">Read more...</a></p>
+    {% endfor %}
+
     <hr class="col-3 col-md-2 mb-5">
 
     <div class="row g-5">
@@ -61,12 +71,13 @@ <h2>Want to know more?</h2>
         <p>Check out these links to find out more about what we are doing!</p>
         <ul class="icon-list ps-0">
           <li class="d-flex align-items-start mb-1"><a href="recent-reviews.html" rel="noopener">Recent Reviews</a></li>
+          <li class="d-flex align-items-start mb-1"><a href="poster.html" rel="noopener">DH2022 Poster</a></li>
         </ul>
       </div>
 
       <div class="col-md-6">
         <h2>Guides</h2>
-        <p>Intersted in submitting code for review or becoming a reviewer? Checks the links below for further information.</p>
+        <p>Interested in submitting code for review or becoming a reviewer? Check out the links below for further information.</p>
         <ul class="icon-list ps-0">
           <li class="d-flex align-items-start mb-1"><a href="https://github.com/DHCodeReview/DHCodeReview/wiki/Authors:-Preparing-a-Code-Review">Preparing a Code Review</a></li>
           <li class="d-flex align-items-start mb-1"><a href="https://github.com/DHCodeReview/DHCodeReview/wiki/Conducting-a-Code-Review">Conducting a Code Review</a></li>

index.html

@@ -0,0 +1,10 @@
+---
+
+layout: default
+---
+
+<h1>Poster at DH2022</h1>
+
+<iframe style="width: 100%; height: 550px" src="assets/files/DH2022-CodeReview-Poster.pdf">
+
+</iframe>