Add new article code reviews

eiselems · eiselems · commit 1991388e3ad9 · 2023-03-11T10:39:22.000+01:00
Also:

* adjusted css slightly
* added new docker container
diff --git a/Gemfile b/Gemfile
@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem "github-pages", '193', group: :jekyll_plugins
+gem 'github-pages', group: :jekyll_plugins
 
 # enable tzinfo-data for local build
 # gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw]
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,13 +1,13 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.10)
+    activesupport (4.2.11.1)
       i18n (~> 0.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
@@ -16,40 +16,38 @@ GEM
     commonmarker (0.17.13)
       ruby-enum (~> 0.5)
     concurrent-ruby (1.1.5)
-    dnsruby (1.61.2)
+    dnsruby (1.61.3)
       addressable (~> 2.5)
     em-websocket (0.5.1)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
     ethon (0.12.0)
       ffi (>= 1.3.0)
     eventmachine (1.2.7)
-    eventmachine (1.2.7-x64-mingw32)
     execjs (2.7.0)
-    faraday (0.15.4)
+    faraday (0.17.0)
       multipart-post (>= 1.2, < 3)
     ffi (1.11.1)
-    ffi (1.11.1-x64-mingw32)
     forwardable-extended (2.6.0)
     gemoji (3.0.1)
-    github-pages (193)
-      activesupport (= 4.2.10)
-      github-pages-health-check (= 1.8.1)
-      jekyll (= 3.7.4)
+    github-pages (202)
+      activesupport (= 4.2.11.1)
+      github-pages-health-check (= 1.16.1)
+      jekyll (= 3.8.5)
       jekyll-avatar (= 0.6.0)
       jekyll-coffeescript (= 1.1.1)
-      jekyll-commonmark-ghpages (= 0.1.5)
+      jekyll-commonmark-ghpages (= 0.1.6)
       jekyll-default-layout (= 0.1.4)
       jekyll-feed (= 0.11.0)
       jekyll-gist (= 1.5.0)
-      jekyll-github-metadata (= 2.9.4)
+      jekyll-github-metadata (= 2.12.1)
       jekyll-mentions (= 1.4.1)
       jekyll-optional-front-matter (= 0.3.0)
       jekyll-paginate (= 1.1.0)
       jekyll-readme-index (= 0.2.0)
       jekyll-redirect-from (= 0.14.0)
-      jekyll-relative-links (= 0.5.3)
-      jekyll-remote-theme (= 0.3.1)
+      jekyll-relative-links (= 0.6.0)
+      jekyll-remote-theme (= 0.4.0)
       jekyll-sass-converter (= 1.5.2)
       jekyll-seo-tag (= 2.5.0)
       jekyll-sitemap (= 1.2.0)
@@ -68,28 +66,28 @@ GEM
       jekyll-theme-tactile (= 0.1.1)
       jekyll-theme-time-machine (= 0.1.1)
       jekyll-titles-from-headings (= 0.5.1)
-      jemoji (= 0.10.1)
+      jemoji (= 0.10.2)
       kramdown (= 1.17.0)
       liquid (= 4.0.0)
       listen (= 3.1.5)
       mercenary (~> 0.3)
       minima (= 2.5.0)
-      nokogiri (>= 1.8.2, < 2.0)
-      rouge (= 2.2.1)
+      nokogiri (>= 1.10.4, < 2.0)
+      rouge (= 3.11.0)
       terminal-table (~> 1.4)
-    github-pages-health-check (1.8.1)
+    github-pages-health-check (1.16.1)
       addressable (~> 2.3)
       dnsruby (~> 1.60)
       octokit (~> 4.0)
-      public_suffix (~> 2.0)
+      public_suffix (~> 3.0)
       typhoeus (~> 1.3)
-    html-pipeline (2.11.0)
+    html-pipeline (2.12.0)
       activesupport (>= 2)
       nokogiri (>= 1.4)
     http_parser.rb (0.6.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    jekyll (3.7.4)
+    jekyll (3.8.5)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -110,18 +108,18 @@ GEM
     jekyll-commonmark (1.3.1)
       commonmarker (~> 0.14)
       jekyll (>= 3.7, < 5.0)
-    jekyll-commonmark-ghpages (0.1.5)
+    jekyll-commonmark-ghpages (0.1.6)
       commonmarker (~> 0.17.6)
-      jekyll-commonmark (~> 1)
-      rouge (~> 2)
+      jekyll-commonmark (~> 1.2)
+      rouge (>= 2.0, < 4.0)
     jekyll-default-layout (0.1.4)
       jekyll (~> 3.0)
     jekyll-feed (0.11.0)
       jekyll (~> 3.3)
     jekyll-gist (1.5.0)
       octokit (~> 4.2)
-    jekyll-github-metadata (2.9.4)
-      jekyll (~> 3.1)
+    jekyll-github-metadata (2.12.1)
+      jekyll (~> 3.4)
       octokit (~> 4.0, != 4.4.0)
     jekyll-mentions (1.4.1)
       html-pipeline (~> 2.3)
@@ -133,9 +131,10 @@ GEM
       jekyll (~> 3.0)
     jekyll-redirect-from (0.14.0)
       jekyll (~> 3.3)
-    jekyll-relative-links (0.5.3)
+    jekyll-relative-links (0.6.0)
       jekyll (~> 3.3)
-    jekyll-remote-theme (0.3.1)
+    jekyll-remote-theme (0.4.0)
+      addressable (~> 2.0)
       jekyll (~> 3.5)
       rubyzip (>= 1.2.1, < 3.0)
     jekyll-sass-converter (1.5.2)
@@ -189,7 +188,7 @@ GEM
       jekyll (~> 3.3)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    jemoji (0.10.1)
+    jemoji (0.10.2)
       gemoji (~> 3.0)
       html-pipeline (~> 2.2)
       jekyll (~> 3.0)
@@ -200,28 +199,24 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     mercenary (0.3.6)
-    mini_portile2 (2.5.1)
+    mini_portile2 (2.4.0)
     minima (2.5.0)
       jekyll (~> 3.5)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
-    minitest (5.11.3)
+    minitest (5.13.0)
     multipart-post (2.1.1)
-    nokogiri (1.11.5)
-      mini_portile2 (~> 2.5.0)
-      racc (~> 1.4)
-    nokogiri (1.11.5-x64-mingw32)
-      racc (~> 1.4)
+    nokogiri (1.10.5)
+      mini_portile2 (~> 2.4.0)
     octokit (4.14.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (2.0.5)
-    racc (1.5.2)
+    public_suffix (3.1.1)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
-    rouge (2.2.1)
+    rouge (3.11.0)
     ruby-enum (0.7.2)
       i18n
     ruby_dep (1.5.0)
@@ -246,12 +241,11 @@ GEM
 
 PLATFORMS
   ruby
-  x64-mingw32
 
 DEPENDENCIES
-  github-pages (= 193)
+  github-pages
   jekyll-paginate
   jekyll-redirect-from
 
 BUNDLED WITH
-   2.2.19
+   1.16.3
diff --git a/_includes/author.html b/_includes/author.html
@@ -6,9 +6,10 @@ <h4>About the Author:</h4>
         <div class="authordescription">
             <p>
                 Marcus is fascinated by technology. He loves learning new things.<br>
-                He is a Software Engineer at <a href="https://www.daimler-tss.com/en/" rel="nofollow">Daimler TSS</a> and has a personal blog at <a href="https://marcuseisele.com/" rel="nofollow">MarcusEisele.com</a>.
+                He is a Software Engineer at <a href="https://www.bosch.com/" rel="nofollow">Bosch</a> and has a
+                personal blog at <a href="https://marcuseisele.com/" rel="nofollow">MarcusEisele.com</a>.
             </p>
-            
+
         </div>
     </div>
 </div>
diff --git a/_posts/2023-03-11-tips-for-improving-code-review-efficiency.md b/_posts/2023-03-11-tips-for-improving-code-review-efficiency.md
@@ -0,0 +1,38 @@
+---
+layout: post
+title: Tips for Improving Code Review Efficiency
+share-img: /img/content/code-review-share.jpg
+image: /img/content/code-review-share.jpg
+bigimg: /img/content/code-review.jpg
+permalink: /tips-for-improving-code-review-efficiency/
+tags: [development, code review]
+---
+
+Code reviews are a vital part of the software development process. They ensure that the code is correct, efficient, and maintainable. However, code reviews can also be time-consuming and often slow down the development process. In this article, we will share some tips for improving code review efficiency.
+
+## 1. Set Clear Guidelines and Standards
+It's essential to establish clear guidelines and standards for code reviews within your team. These guidelines should cover:
+
+* What to look for in detail
+* The level of detail required (e.g. testing the feature vs just looking at the code)
+* How to give constructive feedback
+
+By establishing these standards, you will reduce the amount of time spent on back-and-forth discussions during code reviews.
+
+## 2. Make Small, Regular Changes
+Rather than making big changes to the codebase all at once, it's better to make small, regular changes. Small changes tend to be reviewed faster and more easily, reducing the time spent on code reviews. Furthermore, smaller changes are easier to understand, which makes it easier for reviewers to provide constructive feedback.
+
+## 3. Use Static Code Analysis Tools
+Static Code analysis tools can help identify potential issues and provide suggestions for improvement. By using these tools, you can catch errors and improve the quality of your code before it's even reviewed by your team.
+
+## 4. Prioritize Code Reviews
+Make code reviews a priority within your team. Set aside time for reviewers to focus solely on code reviews, and make sure they have the necessary tools and resources to do so effectively. This will help ensure that code reviews are completed in a timely manner and don't slow down the development process.
+
+## 5. Foster a Collaborative Environment
+Code reviews should be viewed as a collaborative process rather than a way to find faults or assign blame. Encourage your team to ask questions and provide constructive feedback during code reviews. By creating a collaborative environment, you can improve the quality of your code and foster a culture of continuous improvement.
+
+# Conclusion
+
+Code reviews are an essential part of the software development process. By following these tips, you can improve code review efficiency and reduce the amount of time spent on back-and-forth discussions. Remember to set clear guidelines and standards, make small, regular changes, use code analysis tools, prioritize code reviews, and foster a collaborative environment.
+
+We hope you found these tips helpful. Do you have any other tips for improving code review efficiency? Let us know in the comments below!
diff --git a/css/custom.css b/css/custom.css
@@ -43,8 +43,12 @@ pre > code {
 }
 
 .authorbox {
-	background-color: #F5F5F5 !important;
+	background-color: #FFF !important;
+	border-color: #FFF;
 	border-radius: 10px;
+	border-width: 1px;
+	padding: 10px 10px 10px 15px;
+	filter: drop-shadow(0.5rem 0.5rem 1.5rem rgba(0, 0, 0, 0.2));
 }
 
 .authorname {
diff --git a/img/content/code-review-share.jpg b/img/content/code-review-share.jpg
diff --git a/img/content/code-review.jpg b/img/content/code-review.jpg
diff --git a/runLocally.sh b/runLocally.sh
@@ -1,3 +1,3 @@
 #!/usr/bin/env bash
 
-bundle exec jekyll serve --incremental
+docker run -it --rm -v "$PWD":/usr/src/app --publish 127.0.0.1:3000:4000 starefossen/github-pages

Original file line number	Diff line number	Diff line change
`@@ -43,8 +43,12 @@ pre > code {`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`.authorbox {`
`46`		`- background-color: #F5F5F5 !important;`
	`46`	`+ background-color: #FFF !important;`
	`47`	`+ border-color: #FFF;`
`47`	`48`	`border-radius: 10px;`
	`49`	`+ border-width: 1px;`
	`50`	`+ padding: 10px 10px 10px 15px;`
	`51`	`+ filter: drop-shadow(0.5rem 0.5rem 1.5rem rgba(0, 0, 0, 0.2));`
`48`	`52`	`}`
`49`	`53`
`50`	`54`	`.authorname {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`
`3`		`-bundle exec jekyll serve --incremental`
	`3`	`+docker run -it --rm -v "$PWD":/usr/src/app --publish 127.0.0.1:3000:4000 starefossen/github-pages`