Skip to content

Commit 6146684

Browse files
pbolingpboling
committed
📝 Modernize documentation
1 parent cf4744c commit 6146684

16 files changed

+1170
-324
lines changed

‎.rubocop_gradual.lock‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
11
{
2-
"README.md:1427990733": [
3-
[59, 5, 27, "Layout/HashAlignment: Align the keys of a hash literal if they span more than one line.", 528284064],
4-
[60, 5, 28, "Layout/HashAlignment: Align the keys of a hash literal if they span more than one line.", 270738203],
5-
[62, 5, 28, "Layout/HashAlignment: Align the keys of a hash literal if they span more than one line.", 2256693885],
6-
[63, 5, 28, "Layout/HashAlignment: Align the keys of a hash literal if they span more than one line.", 2071774781],
7-
[65, 5, 28, "Layout/HashAlignment: Align the keys of a hash literal if they span more than one line.", 1701904659],
8-
[66, 5, 28, "Layout/HashAlignment: Align the keys of a hash literal if they span more than one line.", 2428992223],
9-
[68, 1, 7, "Layout/IndentationWidth: Use 2 (not 7) spaces for indentation.", 394119301]
10-
],
112
"lib/month/serializer.rb:1935564184": [
123
[8, 5, 63, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 2901108034]
134
],

‎CODE_OF_CONDUCT.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ representative at an online or offline event.
6161

6262
Instances of abusive, harassing, or otherwise unacceptable behavior may be
6363
reported to the community leaders responsible for enforcement at
64-
[![Contact BDFL][🚂bdfl-contact-img]][🚂bdfl-contact].
64+
[![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact].
6565
All complaints will be reviewed and investigated promptly and fairly.
6666

6767
All community leaders are obligated to respect the privacy and security of the
@@ -131,5 +131,5 @@ For answers to common questions about this code of conduct, see the FAQ at
131131
[Mozilla CoC]: https://github.com/mozilla/diversity
132132
[FAQ]: https://www.contributor-covenant.org/faq
133133
[translations]: https://www.contributor-covenant.org/translations
134-
[🚂bdfl-contact]: http://www.railsbling.com/contact
135-
[🚂bdfl-contact-img]: https://img.shields.io/badge/Contact-BDFL-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
134+
[🚂maint-contact]: http://www.railsbling.com/contact
135+
[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red

‎README.md‎

Lines changed: 403 additions & 90 deletions
Large diffs are not rendered by default.

‎docs/Month.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ <h3 class="signature " id="to_i-instance_method">
269269
</div>
270270

271271
<div id="footer">
272-
Generated on Thu Aug 7 03:26:00 2025 by
272+
Generated on Thu Aug 7 12:47:28 2025 by
273273
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
274274
0.9.37 (ruby-3.4.5).
275275
</div>

‎docs/Month/Serializer.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ <h3 class="signature first" id="included-class_method">
193193
</div>
194194

195195
<div id="footer">
196-
Generated on Thu Aug 7 03:26:00 2025 by
196+
Generated on Thu Aug 7 12:47:28 2025 by
197197
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
198198
0.9.37 (ruby-3.4.5).
199199
</div>

‎docs/Month/Serializer/ClassMethods.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ <h3 class="signature " id="load-instance_method">
316316
</div>
317317

318318
<div id="footer">
319-
Generated on Thu Aug 7 03:26:00 2025 by
319+
Generated on Thu Aug 7 12:47:28 2025 by
320320
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
321321
0.9.37 (ruby-3.4.5).
322322
</div>

‎docs/_index.html‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,16 @@ <h2>File Listing</h2>
6666
<li class="r2"><a href="file.CODE_OF_CONDUCT.html" title="CODE_OF_CONDUCT">CODE_OF_CONDUCT</a></li>
6767

6868

69-
<li class="r1"><a href="file.SECURITY.html" title="SECURITY">SECURITY</a></li>
69+
<li class="r1"><a href="file.CONTRIBUTING.html" title="CONTRIBUTING">CONTRIBUTING</a></li>
7070

7171

72-
<li class="r2"><a href="file.LICENSE.html" title="LICENSE">LICENSE</a></li>
72+
<li class="r2"><a href="file.SECURITY.html" title="SECURITY">SECURITY</a></li>
7373

7474

75-
<li class="r1"><a href="file.CITATION.html" title="CITATION">CITATION</a></li>
75+
<li class="r1"><a href="file.LICENSE.html" title="LICENSE">LICENSE</a></li>
76+
77+
78+
<li class="r2"><a href="file.CITATION.html" title="CITATION">CITATION</a></li>
7679

7780

7881
</ul>
@@ -139,7 +142,7 @@ <h2>Namespace Listing A-Z</h2>
139142
</div>
140143

141144
<div id="footer">
142-
Generated on Thu Aug 7 03:26:00 2025 by
145+
Generated on Thu Aug 7 12:47:28 2025 by
143146
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
144147
0.9.37 (ruby-3.4.5).
145148
</div>

‎docs/file.CITATION.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
</div></div>
8383

8484
<div id="footer">
85-
Generated on Thu Aug 7 03:26:00 2025 by
85+
Generated on Thu Aug 7 12:47:28 2025 by
8686
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
8787
0.9.37 (ruby-3.4.5).
8888
</div>

‎docs/file.CODE_OF_CONDUCT.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ <h2 id="enforcement">Enforcement</h2>
124124

125125
<p>Instances of abusive, harassing, or otherwise unacceptable behavior may be<br>
126126
reported to the community leaders responsible for enforcement at<br>
127-
<a href="http://www.railsbling.com/contact"><img src="https://img.shields.io/badge/Contact-BDFL-0093D0.svg?style=flat&amp;logo=rubyonrails&amp;logoColor=red" alt="Contact BDFL"></a>.<br>
127+
<a href="http://www.railsbling.com/contact"><img src="https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&amp;logo=rubyonrails&amp;logoColor=red" alt="Contact Maintainer"></a>.<br>
128128
All complaints will be reviewed and investigated promptly and fairly.</p>
129129

130130
<p>All community leaders are obligated to respect the privacy and security of the<br>
@@ -192,7 +192,7 @@ <h2 id="attribution">Attribution</h2>
192192
</div></div>
193193

194194
<div id="footer">
195-
Generated on Thu Aug 7 03:26:00 2025 by
195+
Generated on Thu Aug 7 12:47:28 2025 by
196196
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
197197
0.9.37 (ruby-3.4.5).
198198
</div>

‎docs/file.CONTRIBUTING.html‎

Lines changed: 200 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>
7+
File: CONTRIBUTING
8+
9+
&mdash; Documentation by YARD 0.9.37
10+
11+
</title>
12+
13+
<link rel="stylesheet" href="css/style.css" type="text/css" />
14+
15+
<link rel="stylesheet" href="css/common.css" type="text/css" />
16+
17+
<script type="text/javascript">
18+
pathId = "CONTRIBUTING";
19+
relpath = '';
20+
</script>
21+
22+
23+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24+
25+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26+
27+
28+
</head>
29+
<body>
30+
<div class="nav_wrap">
31+
<iframe id="nav" src="file_list.html?1"></iframe>
32+
<div id="resizer"></div>
33+
</div>
34+
35+
<div id="main" tabindex="-1">
36+
<div id="header">
37+
<div id="menu">
38+
39+
<a href="_index.html">Index</a> &raquo;
40+
<span class="title">File: CONTRIBUTING</span>
41+
42+
</div>
43+
44+
<div id="search">
45+
46+
<a class="full_list_link" id="class_list_link"
47+
href="class_list.html">
48+
49+
<svg width="24" height="24">
50+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53+
</svg>
54+
</a>
55+
56+
</div>
57+
<div class="clear"></div>
58+
</div>
59+
60+
<div id="content"><div id='filecontents'><h1 id="contributing">Contributing</h1>
61+
62+
<p>Bug reports and pull requests are welcome on GitHub, CodeBerg, or <a href="https://gitlab.com/galtzo-floss/month-serializer">GitLab</a>.<br>
63+
This project should be a safe, welcoming space for collaboration, so contributors agree to adhere to<br>
64+
the <a href="https://gitlab.com/galtzo-floss/month-serializer/-/blob/main/CODE_OF_CONDUCT.md">code of conduct</a>.</p>
65+
66+
<p>To submit a patch, please fork the project, create a patch with tests, and send a pull request.</p>
67+
68+
<p>Remember to <a href="https://keepachangelog.com/en/1.0.0/"><img src="https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat" alt="Keep A Changelog"></a>.</p>
69+
70+
<h2 id="help-out">Help out!</h2>
71+
72+
<p>Take a look at the <code>reek</code> list which is the file called <code>REEK</code> and find something to improve.</p>
73+
74+
<p>Follow these instructions:</p>
75+
76+
<ol>
77+
<li>Fork the repository</li>
78+
<li>Create a feature branch (<code>git checkout -b my-new-feature</code>)</li>
79+
<li>Make some fixes.</li>
80+
<li>Commit changes (<code>git commit -am 'Added some feature'</code>)</li>
81+
<li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
82+
<li>Make sure to add tests for it. This is important, so it doesn’t break in a future release.</li>
83+
<li>Create new Pull Request.</li>
84+
</ol>
85+
86+
<h2 id="appraisals">Appraisals</h2>
87+
88+
<p>From time to time the Appraisal2 gemfiles in <code>gemfiles/</code> will need to be updated.<br>
89+
They are created and updated with the commands:</p>
90+
91+
<pre class="code language-console"><code class="language-console">BUNDLE_GEMFILE=Appraisal.root.gemfile bundle
92+
BUNDLE_GEMFILE=Appraisal.root.gemfile bundle exec appraisal update
93+
bundle exec rake rubocop_gradual:autocorrect
94+
</code></pre>
95+
96+
<p>When adding an appraisal to CI check the <a href="https://github.com/ruby/ruby-builder/releases/tag/toolcache">runner tool cache</a> to see which runner to use.</p>
97+
98+
<h2 id="the-reek-list">The Reek List</h2>
99+
100+
<p>Take a look at the <code>reek</code> list which is the file called <code>REEK</code> and find something to improve.</p>
101+
102+
<p>To refresh the <code>reek</code> list:</p>
103+
104+
<pre class="code language-console"><code class="language-console">bundle exec reek &gt; REEK
105+
</code></pre>
106+
107+
<h2 id="run-tests">Run Tests</h2>
108+
109+
<p>To run all tests</p>
110+
111+
<pre class="code language-console"><code class="language-console">bundle exec rake test
112+
</code></pre>
113+
114+
<h2 id="lint-it">Lint It</h2>
115+
116+
<p>Run all the default tasks, which includes running the gradually autocorrecting linter, <code>rubocop-gradual</code>.</p>
117+
118+
<pre class="code language-console"><code class="language-console">bundle exec rake
119+
</code></pre>
120+
121+
<p>Or just run the linter.</p>
122+
123+
<pre class="code language-console"><code class="language-console">bundle exec rake rubocop_gradual:autocorrect
124+
</code></pre>
125+
126+
<h2 id="contributors">Contributors</h2>
127+
128+
<p>Your picture could be here!</p>
129+
130+
<p><a href="https://github.com/galtzo-floss/month-serializer/graphs/contributors"><img src="https://contrib.rocks/image?repo=galtzo-floss/month-serializer" alt="Contributors"></a></p>
131+
132+
<p>Made with <a href="https://contrib.rocks">contributors-img</a>.</p>
133+
134+
<p>Also see GitLab Contributors: <a href="https://gitlab.com/galtzo-floss/month-serializer/-/graphs/main">https://gitlab.com/galtzo-floss/month-serializer/-/graphs/main</a></p>
135+
136+
<h2 id="for-maintainers">For Maintainers</h2>
137+
138+
<h3 id="one-time-per-maintainer-setup">One-time, Per-maintainer, Setup</h3>
139+
140+
<p><strong>IMPORTANT</strong>: If you want to sign the build you create,<br>
141+
your public key for signing gems will need to be picked up by the line in the<br>
142+
<code>gemspec</code> defining the <code>spec.cert_chain</code> (check the relevant ENV variables there).<br>
143+
All releases to RubyGems.org will be signed.<br>
144+
See: <a href="https://guides.rubygems.org/security/#building-gems">RubyGems Security Guide</a></p>
145+
146+
<p>NOTE: To build without signing the gem you must set <code>SKIP_GEM_SIGNING</code> to some value in your environment.</p>
147+
148+
<h3 id="to-release-a-new-version">To release a new version:</h3>
149+
150+
<ol>
151+
<li>Run <code>bin/setup &amp;&amp; bin/rake</code> as a “test, coverage, &amp; linting” sanity check</li>
152+
<li>Update the version number in <code>version.rb</code>, and ensure <code>CHANGELOG.md</code> reflects changes</li>
153+
<li>Run <code>bin/setup &amp;&amp; bin/rake</code> again as a secondary check, and to update <code>Gemfile.lock</code>
154+
</li>
155+
<li>Run <code>git commit -am "🔖 Prepare release v&lt;VERSION&gt;"</code> to commit the changes</li>
156+
<li>Run <code>git push</code> to trigger the final CI pipeline before release, and merge PRs
157+
<ul>
158+
<li>NOTE: Remember to <a href="https://github.com/galtzo-floss/month-serializer/actions">check the build</a>.</li>
159+
</ul>
160+
</li>
161+
<li>Run <code>export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" &amp;&amp; echo $GIT_TRUNK_BRANCH_NAME</code>
162+
</li>
163+
<li>Run <code>git checkout $GIT_TRUNK_BRANCH_NAME</code>
164+
</li>
165+
<li>Run <code>git pull origin $GIT_TRUNK_BRANCH_NAME</code> to ensure latest trunk code</li>
166+
<li>Set <code>SOURCE_DATE_EPOCH</code> so <code>rake build</code> and <code>rake release</code> use same timestamp, and generate same checksums
167+
<ul>
168+
<li>Run <code>export SOURCE_DATE_EPOCH=$EPOCHSECONDS &amp;&amp; echo $SOURCE_DATE_EPOCH</code>
169+
</li>
170+
<li>If the echo above has no output, then it didn’t work.</li>
171+
<li>Note: <code>zsh/datetime</code> module is needed, if running <code>zsh</code>.</li>
172+
<li>In older versions of <code>bash</code> you can use <code>date +%s</code> instead, i.e. <code>export SOURCE_DATE_EPOCH=$(date +%s) &amp;&amp; echo $SOURCE_DATE_EPOCH</code>
173+
</li>
174+
</ul>
175+
</li>
176+
<li>Run <code>bundle exec rake build</code>
177+
</li>
178+
<li>Run <code>bin/gem_checksums</code> (more context <a href="https://github.com/rubygems/rubygems/pull/6022">1</a>, <a href="https://github.com/rubygems/guides/pull/325">2</a>)<br>
179+
to create SHA-256 and SHA-512 checksums. This functionality is provided by the <code>stone_checksums</code><br>
180+
<a href="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/galtzo-floss/stone_checksums">gem</a>.
181+
<ul>
182+
<li>The script automatically commits but does not push the checksums</li>
183+
</ul>
184+
</li>
185+
<li>Run <code>bundle exec rake release</code> which will create a git tag for the version,<br>
186+
push git commits and tags, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>
187+
</li>
188+
</ol>
189+
190+
</div></div>
191+
192+
<div id="footer">
193+
Generated on Thu Aug 7 12:47:28 2025 by
194+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
195+
0.9.37 (ruby-3.4.5).
196+
</div>
197+
198+
</div>
199+
</body>
200+
</html>

0 commit comments

Comments
 (0)