Skip to content

Process and deadlines #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rlskoeser merged 2 commits into from
Jan 19, 2024
Merged

Process and deadlines #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b4bafc
Added process desciption and deadlines
jdamerow Jan 19, 2024
9e664ac
merged develop
jdamerow Jan 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions _layouts/default.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@


<link href="/assets/css/bootstrap.min.css" rel="stylesheet">
<script src="/assets/js/bootstrap.bundle.min.js"></script>

<meta name="theme-color" content="#712cf9">

Expand Down Expand Up @@ -75,19 +76,29 @@
<body>

<div class="col-lg-8 mx-auto p-4 py-md-5">
<header class="d-flex align-items-center pb-3 mb-5 border-bottom">
<nav class="navbar navbar-expand-lg pb-3 mb-5 bg-body-tertiary border-bottom">
<div class="container-fluid">
<a href="/" class="d-flex align-items-center text-dark text-decoration-none">
<img src="/assets/imgs/logo.svg" width="80">
<span class="fs-4">DHTech Community Code Review Working Group</span>
</a>
</header>
<ul class="nav justify-content-end">
<li class="nav-item dropdown">
<a class="nav-link dropdown-toggle" data-bs-toggle="dropdown" href="#" role="button" aria-expanded="false">Let's Go!</a>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="submit-code.html">Submit Code</a></li>
<li><a class="dropdown-item" href="https://forms.gle/PepxF6U64AT2Y5TZA">Become Reviewer</a></li>
</ul>
</li>
</ul>
</nav>

<main>
{{ content }}

</main>
<footer class="pt-5 my-5 text-muted border-top">
DHTech Code Review Working Group &middot; &copy; 2022
DHTech Code Review Working Group &middot; &copy; 2024
</footer>
</div>

Expand Down
4 changes: 2 additions & 2 deletions assets/css/bootstrap.min.css
View file
Open in desktop

Large diffs are not rendered by default.

19 changes: 13 additions & 6 deletions assets/css/site.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
:root{
--bs-primary:##E36414;
--bs-blue:##E36414;
--bs-link-color:#e37c1c;
--bs-link-hover-color: #FB8B24;
}
.btn-primary {
--bs-btn-bg: #e37c1c;
--bs-btn-border-color:#e37c1c;
--bs-btn-hover-bg: #FB8B24;
--bs-btn-hover-border-color: #FB8B24;
}

.icon-list li::before {
display: block;
flex-shrink: 0;
Expand All @@ -12,10 +25,4 @@
color:#0F4C5C;
}

a {
color: #E36414;
}

a:hover {
color: #FB8B24;
}
7 changes: 7 additions & 0 deletions assets/js/bootstrap.bundle.min.js
View file
Open in desktop

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions assets/js/bootstrap.min.js
View file
Open in desktop

Large diffs are not rendered by default.

51 changes: 49 additions & 2 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,55 @@

layout: default
---


<h1>Community Code Review</h1>
<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>
<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>

<p>
<a href="submit-code.html" class="btn btn-primary btn-sm" type="submit">Submit Code for Review</a>
&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">

<h2>Our Process</h2>
<p>
We are always trying to improve our code review process to fit best for the needs of the community. Currently, our process is as follows.

<ul>
<li>We try to find two reviewers for each piece of code that is submitted for review.</li>
<li>We schedule two weeks for the review to be completed.</li>
<li>We schedule an half hour Zoom meeting at the beginning of the review period with both reviewers and the submitter(s) of the code to discuss general questions such as the problem the code is trying to solve, general setup requirements, and any other questions the reviewers might have.</li>
<li>Reviewers and submitters are being added to a channel in the DHTech workspace where they can communicate about the code and during the review process.</li>
<li>Reviews are being conducted via pull requests in GitHub.</li>
<li>We schedule a 1 hour wrap up Zoom meeting with reviewers and submitters to discuss the reviewer's comments on the code and any questions reviewers or submitters might have.</li>
<li>Submitters are asked to recognize the work of the reviewers by adding their names to the code's repository or in other places where it makes sense.</li>
</ul>
</p>

<hr class="col-3 col-md-2 mb-5">

<h2>Submission Deadlines</h2>

<p>
Our quarterly deadlines to submit code for review are as follows:
</p>
<ul>
<li>March 31</li>
<li>June 30</li>
<li>September 30</li>
<li>December 31</li>
</ul>

<p>
<a href="submit-code.html" class="btn btn-primary btn-sm" type="submit">Submit Code for Review</a>
&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>
Expand Down Expand Up @@ -38,7 +81,11 @@ <h2>Guides</h2>
<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>
<li class="d-flex align-items-start mb-1"><a href="https://github.com/DHCodeReview/DHCodeReview/wiki/Code-Review-Checklists">Code Review Checklist</a></li>
<li class="d-flex align-items-start mb-1"><a href="https://github.com/DHCodeReview/DHCodeReview/wiki/Code-Review-Guidelines">Code Review Guidelines</a></li>
</ul>
</div>
</div>

</div>


30 changes: 26 additions & 4 deletions recent-reviews.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,31 @@
<h1>Recent Code Reviews</h1>

We have started the alpha phase of a community code review process. Below is a list of some of the reviews that were conducted.

<hr>
<h2>2023</h2>
<ul class="list-group list-group-flush">
<li class="list-group-item">
<a href="https://github.com/DHCodeReview/lenape-timetree/pull/2">Lunaapahkiing Princeton Timetree</a>
<br>Submitter: Rebecca Sutton Koeser (Princeton University)
<br>Reviewers: Cole Crawford, Raffaele Viglianti
</li>
</ul>
<hr>
<h2>2022</h2>
<ul class="list-group list-group-flush">
<li class="list-group-item"><a href="https://github.com/DHCodeReview/oimdp/pull/1">oimdp: OpenITI mARkdown Parser</a></li>
<li class="list-group-item"><a href="https://github.com/DHCodeReview/pydistinto/pull/1">Pydistinto</a></li>
<li class="list-group-item"><a href="https://github.com/DHCodeReview/SemanticLayerTools/pull/1">SemanticLayerTools</a></li>
<li class="list-group-item">
<a href="https://github.com/DHCodeReview/oimdp/pull/1">oimdp: OpenITI mARkdown Parser</a>
<br>Submitter: Raff Viglianti (University of Maryland)
<br>Reviewer: Malte Vogl
</li>
<li class="list-group-item">
<a href="https://github.com/DHCodeReview/pydistinto/pull/1">Pydistinto</a>
<br>Submitter: Keli Du (Trier Center for Digital Humanities)
<br>Reviewer: Moritz Mähr
</li>
<li class="list-group-item">
<a href="https://github.com/DHCodeReview/SemanticLayerTools/pull/1">SemanticLayerTools</a>
<br>Submitter: Malte Vogl (Max Planck Institute for the History of Science)
<br>Reviewer: Itay Zandbank
</li>
</ul>
39 changes: 39 additions & 0 deletions submit-code.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: default
---
<h2>What code can be reviewed?</h2>
<p>
Code reviews can be pretty time consuming. When requesting a review, please only submit requests for code that can be understood and reviewed in roughly an hour. This means, at this point, we can't accept requests for extensive libraries and whole desktop or web applications.
</p>

<h2>General requirements</h2>
<p>
To effectively review your code, please make sure the following conditions are met:
</p>
<ul>
<li>Your repository is publicly available.</li>
<li>There is a LICENSE file in the repository.</li>
<li>Documentation is available and clearly accessible (e.g. a README file in the repository).
<ul>
<li>The documentation contains installation instructions.</li>
<li>The documentation contains a description of what problem the code solves and its functionality. </li>
</ul>
</li>
<li>Example data is available.</li>
</ul>

<h2>How to submit a review request?</h2>
<p>
When getting ready to submit code for a review, please make sure to have the following information available (you will need them for the submission form):
</p>
<ul>
<li>Link to the GitHub repository that contains the code to be reviewed. Ideally the repository would only contain the code that should be reviewed. If, however, there is more code that shouldn't be reviewed please note so in the form.
What is the utilized programming language?</li>
<li>Who are the authors and contributors and what did they contribute? What are the roles of the submitters?</li>
<li>Are there supporting papers (that, for example, describe employed algorithms)?</li>
<li>For which field was the code developed?</li>
<li>Are there any standards the reviewer should know? Is there any other domain knowledge required?</li>
<li>Are there any requirements that need to be fulfilled for the code to run (e.g. hardware requirements, OS requirements, etc)?</li>
<li>Anything else we need to know?</li>
</ul>
To submit a review, please fill out <a href="https://forms.gle/pBm2jUVqz65dPHi28">this form</a>.