Skip to content

Commit 15db82a

Browse files
author
Quarto GHA Workflow Runner
committed
Built site for gh-pages
1 parent 77c399c commit 15db82a

15 files changed

Lines changed: 1794 additions & 1130 deletions

.nojekyll

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
ba23f137
1+
fa436ae3

CHANGELOG.html

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,16 @@
8787
<ul class="navbar-nav navbar-nav-scroll me-auto">
8888
<li class="nav-item">
8989
<a class="nav-link" href="./index.html">
90-
<span class="menu-text">Home</span></a>
90+
<span class="menu-text">Tutorial</span></a>
9191
</li>
9292
<li class="nav-item">
9393
<a class="nav-link" href="./reference/index.html">
9494
<span class="menu-text">Reference</span></a>
9595
</li>
96+
<li class="nav-item">
97+
<a class="nav-link" href="./CONTRIBUTING.html">
98+
<span class="menu-text">Contributing</span></a>
99+
</li>
96100
</ul>
97101
</div> <!-- /navcollapse -->
98102
<div class="quarto-navbar-tools">
@@ -115,11 +119,29 @@
115119
<h1>Changelog</h1>
116120
<p>All notable changes to this project will be documented in this file.</p>
117121
<p>The format is based on <a href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>, and this project adheres to <a href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
118-
<section id="milestone-3---2026-01-25" class="level2">
119-
<h2 class="anchored" data-anchor-id="milestone-3---2026-01-25">[2.0.0] (Milestone 3) - 2026-01-25</h2>
122+
<section id="milestone-4---2026-02-02" class="level2">
123+
<h2 class="anchored" data-anchor-id="milestone-4---2026-02-02">[3.0.0] (Milestone 4) - 2026-02-02</h2>
124+
<section id="fixed" class="level3">
125+
<h3 class="anchored" data-anchor-id="fixed">Fixed</h3>
126+
<ul>
127+
<li>PR <a href="https://github.com/UBC-MDS/DSCI_524_group37_csvplus/pull/114">#114</a> to reorganize <code>README.md</code> for clarity and usability for both users and developers to address peer review Issue <a href="https://github.com/UBC-MDS/DSCI_524_group37_csvplus/issues/103">#103</a></li>
128+
<li>PR <a href="https://github.com/UBC-MDS/DSCI_524_group37_csvplus/pull/121">#121</a> to fix <code>resolve_string_value()</code> example in <code>README.md</code> to address peer review Issue <a href="https://github.com/UBC-MDS/DSCI_524_group37_csvplus/issues/100">#100</a></li>
129+
<li>Addressed inconsistencies in test_generate_report.py (#122)</li>
130+
<li>PR <a href="https://github.com/UBC-MDS/DSCI_524_group37_csvplus/pull/131">#131</a> to add author emails to address peer review Issue <a href="https://github.com/UBC-MDS/DSCI_524_group37_csvplus/issues/130">#130</a></li>
131+
</ul>
132+
</section>
120133
<section id="added" class="level3">
121134
<h3 class="anchored" data-anchor-id="added">Added</h3>
122135
<ul>
136+
<li>Retrospective and next steps to CONTRIBUTING.md (#126)</li>
137+
</ul>
138+
</section>
139+
</section>
140+
<section id="milestone-3---2026-01-25" class="level2">
141+
<h2 class="anchored" data-anchor-id="milestone-3---2026-01-25">[2.0.0] (Milestone 3) - 2026-01-25</h2>
142+
<section id="added-1" class="level3">
143+
<h3 class="anchored" data-anchor-id="added-1">Added</h3>
144+
<ul>
123145
<li>Additional unit tests for improved coverage (#95, #80)</li>
124146
<li>Flake8 linter to workflow (#83)</li>
125147
<li>Quartodoc YAML file for documentation (#91)</li>
@@ -136,8 +158,8 @@ <h3 class="anchored" data-anchor-id="changed">Changed</h3>
136158
<li>Installed necessary dev and test dependencies (#69)</li>
137159
</ul>
138160
</section>
139-
<section id="fixed" class="level3">
140-
<h3 class="anchored" data-anchor-id="fixed">Fixed</h3>
161+
<section id="fixed-1" class="level3">
162+
<h3 class="anchored" data-anchor-id="fixed-1">Fixed</h3>
141163
<ul>
142164
<li>Linter issues (#98)</li>
143165
<li>Action version and added skip-existing option (#96)</li>
@@ -149,8 +171,8 @@ <h3 class="anchored" data-anchor-id="fixed">Fixed</h3>
149171
</section>
150172
<section id="milestone-2---2026-01-17" class="level2">
151173
<h2 class="anchored" data-anchor-id="milestone-2---2026-01-17">[1.0.0] (Milestone 2) - 2026-01-17</h2>
152-
<section id="added-1" class="level3">
153-
<h3 class="anchored" data-anchor-id="added-1">Added</h3>
174+
<section id="added-2" class="level3">
175+
<h3 class="anchored" data-anchor-id="added-2">Added</h3>
154176
<ul>
155177
<li>Implemented <code>data_version_diff</code> function (#46)</li>
156178
<li>Created tests for <code>data_version_diff</code> function (#53)</li>
@@ -172,8 +194,8 @@ <h3 class="anchored" data-anchor-id="changed-1">Changed</h3>
172194
</section>
173195
<section id="milestone-1---2026-01-10" class="level2">
174196
<h2 class="anchored" data-anchor-id="milestone-1---2026-01-10">[0.0.1] (Milestone 1) - 2026-01-10</h2>
175-
<section id="added-2" class="level3">
176-
<h3 class="anchored" data-anchor-id="added-2">Added</h3>
197+
<section id="added-3" class="level3">
198+
<h3 class="anchored" data-anchor-id="added-3">Added</h3>
177199
<ul>
178200
<li>Initial commit with project setup</li>
179201
<li>Function stub and docstring for <code>data_version_diff</code> (#17)</li>
@@ -191,8 +213,8 @@ <h3 class="anchored" data-anchor-id="changed-2">Changed</h3>
191213
<li>Added raised errors to docstring (#16)</li>
192214
</ul>
193215
</section>
194-
<section id="fixed-1" class="level3">
195-
<h3 class="anchored" data-anchor-id="fixed-1">Fixed</h3>
216+
<section id="fixed-2" class="level3">
217+
<h3 class="anchored" data-anchor-id="fixed-2">Fixed</h3>
196218
<ul>
197219
<li>Address inconsistencies in function names in README.md and data-correction.py (#21)</li>
198220
</ul>

CODE_OF_CONDUCT.html

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,16 @@
8787
<ul class="navbar-nav navbar-nav-scroll me-auto">
8888
<li class="nav-item">
8989
<a class="nav-link" href="./index.html">
90-
<span class="menu-text">Home</span></a>
90+
<span class="menu-text">Tutorial</span></a>
9191
</li>
9292
<li class="nav-item">
9393
<a class="nav-link" href="./reference/index.html">
9494
<span class="menu-text">Reference</span></a>
9595
</li>
96+
<li class="nav-item">
97+
<a class="nav-link" href="./CONTRIBUTING.html">
98+
<span class="menu-text">Contributing</span></a>
99+
</li>
96100
</ul>
97101
</div> <!-- /navcollapse -->
98102
<div class="quarto-navbar-tools">

CONTRIBUTING.html

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,16 @@
8787
<ul class="navbar-nav navbar-nav-scroll me-auto">
8888
<li class="nav-item">
8989
<a class="nav-link" href="./index.html">
90-
<span class="menu-text">Home</span></a>
90+
<span class="menu-text">Tutorial</span></a>
9191
</li>
9292
<li class="nav-item">
9393
<a class="nav-link" href="./reference/index.html">
9494
<span class="menu-text">Reference</span></a>
9595
</li>
96+
<li class="nav-item">
97+
<a class="nav-link active" href="./CONTRIBUTING.html" aria-current="page">
98+
<span class="menu-text">Contributing</span></a>
99+
</li>
96100
</ul>
97101
</div> <!-- /navcollapse -->
98102
<div class="quarto-navbar-tools">
@@ -219,6 +223,13 @@ <h2 class="anchored" data-anchor-id="decision-making-and-conflict-resolution">De
219223
<li>If consensus cannot be reached, the team will vote</li>
220224
<li>Blocking issues should be raised as early as possible to avoid deadline risk</li>
221225
</ul>
226+
</section>
227+
<section id="retrospective-and-next-steps" class="level2">
228+
<h2 class="anchored" data-anchor-id="retrospective-and-next-steps">Retrospective and Next Steps</h2>
229+
<p>Our group used the development tools introduced in DSCI 524, including Python Packages, PyTest, Continuous Integration and Deployment, and publishing on PyPI. Flake8 linter was used to maintain code quality.</p>
230+
<p>We followed a GitHub flow workflow, where we listed Issues and created a branch for each issue. Each pull request addresses a specific issue and requires a review from at least one other group member before merging.</p>
231+
<p>GitHub was our main form of organization, with Issues used to communicate, report bugs, and keep track of progress. For timely responses, we also used Slack as a secondary means of communication.</p>
232+
<p>If we were to scale up our project, we would still used Git version control and CI/CD with trunk-based development. External software such as Jira can be used for task management and bug reporting. In general, the tools used in this course are well-suited for adaptation at a larger scale.</p>
222233

223234

224235
</section>

DEVELOPMENT.html

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,12 +122,16 @@
122122
<ul class="navbar-nav navbar-nav-scroll me-auto">
123123
<li class="nav-item">
124124
<a class="nav-link" href="./index.html">
125-
<span class="menu-text">Home</span></a>
125+
<span class="menu-text">Tutorial</span></a>
126126
</li>
127127
<li class="nav-item">
128128
<a class="nav-link" href="./reference/index.html">
129129
<span class="menu-text">Reference</span></a>
130130
</li>
131+
<li class="nav-item">
132+
<a class="nav-link" href="./CONTRIBUTING.html">
133+
<span class="menu-text">Contributing</span></a>
134+
</li>
131135
</ul>
132136
</div> <!-- /navcollapse -->
133137
<div class="quarto-navbar-tools">

0 commit comments

Comments
 (0)