Skip to content

Commit 2440dfb

Browse files
rlskoeserrlskoeser
authored
Merge pull request #2 from DHCodeReview/process-and-deadlines
Process and deadlines
2 parents 35d4724 + 9e664ac commit 2440dfb

File tree

8 files changed

+157
-17
lines changed

8 files changed

+157
-17
lines changed

‎_layouts/default.html‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212

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

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

@@ -75,19 +76,29 @@
7576
<body>
7677

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

8596
<main>
8697
{{ content }}
8798

8899
</main>
89100
<footer class="pt-5 my-5 text-muted border-top">
90-
DHTech Code Review Working Group &middot; &copy; 2022
101+
DHTech Code Review Working Group &middot; &copy; 2024
91102
</footer>
92103
</div>
93104

‎assets/css/bootstrap.min.css‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎assets/css/site.css‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
:root{
2+
--bs-primary:##E36414;
3+
--bs-blue:##E36414;
4+
--bs-link-color:#e37c1c;
5+
--bs-link-hover-color: #FB8B24;
6+
}
7+
.btn-primary {
8+
--bs-btn-bg: #e37c1c;
9+
--bs-btn-border-color:#e37c1c;
10+
--bs-btn-hover-bg: #FB8B24;
11+
--bs-btn-hover-border-color: #FB8B24;
12+
}
13+
114
.icon-list li::before {
215
display: block;
316
flex-shrink: 0;
@@ -12,10 +25,4 @@
1225
color:#0F4C5C;
1326
}
1427

15-
a {
16-
color: #E36414;
17-
}
1828

19-
a:hover {
20-
color: #FB8B24;
21-
}

‎assets/js/bootstrap.bundle.min.js‎

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎assets/js/bootstrap.min.js‎

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎index.html‎

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,55 @@
44

55
layout: default
66
---
7+
8+
79
<h1>Community Code Review</h1>
810
<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>
911

10-
<p>
12+
<p>
1113
<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>
1214

15+
<p>
16+
<a href="submit-code.html" class="btn btn-primary btn-sm" type="submit">Submit Code for Review</a>
17+
&nbsp;
18+
<a href="https://forms.gle/PepxF6U64AT2Y5TZA" class="btn btn-primary btn-sm" type="submit">Become a Reviewer</a>
19+
</p>
20+
<hr class="col-3 col-md-2 mb-5">
21+
22+
<h2>Our Process</h2>
23+
<p>
24+
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.
25+
26+
<ul>
27+
<li>We try to find two reviewers for each piece of code that is submitted for review.</li>
28+
<li>We schedule two weeks for the review to be completed.</li>
29+
<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>
30+
<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>
31+
<li>Reviews are being conducted via pull requests in GitHub.</li>
32+
<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>
33+
<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>
34+
</ul>
35+
</p>
36+
37+
<hr class="col-3 col-md-2 mb-5">
38+
39+
<h2>Submission Deadlines</h2>
40+
41+
<p>
42+
Our quarterly deadlines to submit code for review are as follows:
43+
</p>
44+
<ul>
45+
<li>March 31</li>
46+
<li>June 30</li>
47+
<li>September 30</li>
48+
<li>December 31</li>
49+
</ul>
50+
51+
<p>
52+
<a href="submit-code.html" class="btn btn-primary btn-sm" type="submit">Submit Code for Review</a>
53+
&nbsp;
54+
<a href="https://forms.gle/PepxF6U64AT2Y5TZA" class="btn btn-primary btn-sm" type="submit">Become a Reviewer</a>
55+
</p>
1356
<hr class="col-3 col-md-2 mb-5">
1457
{% for post in site.posts limit:1 %}
1558
<h2>{{ post.title}}</h2>
@@ -38,7 +81,11 @@ <h2>Guides</h2>
3881
<ul class="icon-list ps-0">
3982
<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>
4083
<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>
84+
<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>
4185
<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>
4286
</ul>
4387
</div>
44-
</div>
88+
89+
</div>
90+
91+

‎recent-reviews.html‎

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,31 @@
44
<h1>Recent Code Reviews</h1>
55

66
We have started the alpha phase of a community code review process. Below is a list of some of the reviews that were conducted.
7-
7+
<hr>
8+
<h2>2023</h2>
9+
<ul class="list-group list-group-flush">
10+
<li class="list-group-item">
11+
<a href="https://github.com/DHCodeReview/lenape-timetree/pull/2">Lunaapahkiing Princeton Timetree</a>
12+
<br>Submitter: Rebecca Sutton Koeser (Princeton University)
13+
<br>Reviewers: Cole Crawford, Raffaele Viglianti
14+
</li>
15+
</ul>
16+
<hr>
17+
<h2>2022</h2>
818
<ul class="list-group list-group-flush">
9-
<li class="list-group-item"><a href="https://github.com/DHCodeReview/oimdp/pull/1">oimdp: OpenITI mARkdown Parser</a></li>
10-
<li class="list-group-item"><a href="https://github.com/DHCodeReview/pydistinto/pull/1">Pydistinto</a></li>
11-
<li class="list-group-item"><a href="https://github.com/DHCodeReview/SemanticLayerTools/pull/1">SemanticLayerTools</a></li>
19+
<li class="list-group-item">
20+
<a href="https://github.com/DHCodeReview/oimdp/pull/1">oimdp: OpenITI mARkdown Parser</a>
21+
<br>Submitter: Raff Viglianti (University of Maryland)
22+
<br>Reviewer: Malte Vogl
23+
</li>
24+
<li class="list-group-item">
25+
<a href="https://github.com/DHCodeReview/pydistinto/pull/1">Pydistinto</a>
26+
<br>Submitter: Keli Du (Trier Center for Digital Humanities)
27+
<br>Reviewer: Moritz Mähr
28+
</li>
29+
<li class="list-group-item">
30+
<a href="https://github.com/DHCodeReview/SemanticLayerTools/pull/1">SemanticLayerTools</a>
31+
<br>Submitter: Malte Vogl (Max Planck Institute for the History of Science)
32+
<br>Reviewer: Itay Zandbank
33+
</li>
1234
</ul>

‎submit-code.html‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
layout: default
3+
---
4+
<h2>What code can be reviewed?</h2>
5+
<p>
6+
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.
7+
</p>
8+
9+
<h2>General requirements</h2>
10+
<p>
11+
To effectively review your code, please make sure the following conditions are met:
12+
</p>
13+
<ul>
14+
<li>Your repository is publicly available.</li>
15+
<li>There is a LICENSE file in the repository.</li>
16+
<li>Documentation is available and clearly accessible (e.g. a README file in the repository).
17+
<ul>
18+
<li>The documentation contains installation instructions.</li>
19+
<li>The documentation contains a description of what problem the code solves and its functionality. </li>
20+
</ul>
21+
</li>
22+
<li>Example data is available.</li>
23+
</ul>
24+
25+
<h2>How to submit a review request?</h2>
26+
<p>
27+
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):
28+
</p>
29+
<ul>
30+
<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.
31+
What is the utilized programming language?</li>
32+
<li>Who are the authors and contributors and what did they contribute? What are the roles of the submitters?</li>
33+
<li>Are there supporting papers (that, for example, describe employed algorithms)?</li>
34+
<li>For which field was the code developed?</li>
35+
<li>Are there any standards the reviewer should know? Is there any other domain knowledge required?</li>
36+
<li>Are there any requirements that need to be fulfilled for the code to run (e.g. hardware requirements, OS requirements, etc)?</li>
37+
<li>Anything else we need to know?</li>
38+
</ul>
39+
To submit a review, please fill out <a href="https://forms.gle/pBm2jUVqz65dPHi28">this form</a>.

0 commit comments

Comments
 (0)