Skip to content

Commit 439b288

Browse files
TuntiiTuntii
committed
Update COMMUNITY.html
1 parent 975f484 commit 439b288

1 file changed

Lines changed: 18 additions & 11 deletions

File tree

‎docs/COMMUNITY.html‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@
3636
const path_to_root = "";
3737
const default_light_theme = "light";
3838
const default_dark_theme = "navy";
39-
window.path_to_searchindex_js = "searchindex-9033ebbb.js";
39+
window.path_to_searchindex_js = "searchindex-f8dd45a5.js";
4040
</script>
4141
<!-- Start loading toc.js asap -->
42-
<script src="toc-888d8050.js"></script>
42+
<script src="toc-17de643b.js"></script>
4343
</head>
4444
<body>
4545
<div id="mdbook-help-container">
@@ -201,17 +201,17 @@ <h2 id="get-help"><a class="header" href="#get-help">Get help</a></h2>
201201
<h2 id="contribute"><a class="header" href="#contribute">Contribute</a></h2>
202202
<p>We accept contributions of all sizes:</p>
203203
<ul>
204-
<li><strong>Code</strong> — bug fixes, features, tests, benchmarks</li>
205-
<li><strong>Documentation</strong> — README, cookbook, examples, typo fixes</li>
206-
<li><strong>Examples</strong> — in-repo samples or the <a href="https://github.com/Tuntii/rustapi-rs-examples">examples repository</a></li>
207-
<li><strong>Community</strong> — issue triage, discussion answers, release testing</li>
204+
<li><strong>Code</strong> — bug fixes, features, tests, benchmarks</li>
205+
<li><strong>Documentation</strong> — README, cookbook, examples, typo fixes</li>
206+
<li><strong>Examples</strong> — in-repo samples or the <a href="https://github.com/Tuntii/rustapi-rs-examples">examples repository</a></li>
207+
<li><strong>Community</strong> — issue triage, discussion answers, release testing</li>
208208
</ul>
209209
<p>Start here:</p>
210210
<ol>
211211
<li>Read <a href="../CONTRIBUTING.html">CONTRIBUTING.md</a> for setup, testing, and PR workflow</li>
212212
<li>Read <a href="../CODE_OF_CONDUCT.html">CODE_OF_CONDUCT.md</a></li>
213213
<li>Pick an issue labeled <a href="https://github.com/Tuntii/RustAPI/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22"><code>good first issue</code></a> or <a href="https://github.com/Tuntii/RustAPI/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22"><code>help wanted</code></a> when available</li>
214-
<li>Fork → branch → PR (squash merge to <code>main</code>)</li>
214+
<li>Fork → branch → PR (squash merge to <code>main</code>)</li>
215215
</ol>
216216
<h3 id="documentation-contributions"><a class="header" href="#documentation-contributions">Documentation contributions</a></h3>
217217
<p>Documentation lives in several places:</p>
@@ -230,6 +230,12 @@ <h3 id="documentation-contributions"><a class="header" href="#documentation-cont
230230
</table>
231231
</div>
232232
<p>When you change public behavior, update the cookbook recipe or reference page that matches the feature. When you only fix internals, a CHANGELOG entry under <strong>Changed</strong> or <strong>Fixed</strong> is enough.</p>
233+
<p>Key docs to keep in sync on release:</p>
234+
<ul>
235+
<li>Version pins in <code>docs/GETTING_STARTED.md</code>, cookbook recipes, and <code>README.md</code></li>
236+
<li><a href="PRODUCTION_BASELINE.html">Production Baseline</a> and <a href="PRODUCTION_CHECKLIST.html">Production Checklist</a> when defaults change</li>
237+
<li><a href="cookbook/src/recipes/rustapi_cloud.html">RustAPI Cloud recipe</a> when CLI cloud commands change</li>
238+
</ul>
233239
<h3 id="public-api-changes"><a class="header" href="#public-api-changes">Public API changes</a></h3>
234240
<p>User-facing API surface is defined by the <code>rustapi-rs</code> facade. Changes that affect public types or feature flags may require:</p>
235241
<ul>
@@ -240,13 +246,14 @@ <h3 id="public-api-changes"><a class="header" href="#public-api-changes">Public
240246
<p>See <a href="../CONTRACT.html">CONTRACT.md</a> for stability rules.</p>
241247
<h2 id="project-values"><a class="header" href="#project-values">Project values</a></h2>
242248
<ul>
243-
<li><strong>Stable facade</strong> — application code imports <code>rustapi-rs</code>, not internal crates</li>
244-
<li><strong>Evidence over claims</strong> — benchmarks and behavior changes should be test-backed</li>
245-
<li><strong>Small, reviewable PRs</strong> — easier to merge and safer for contributors</li>
246-
<li><strong>Respectful collaboration</strong> — see the Code of Conduct</li>
249+
<li><strong>Stable facade</strong> — application code imports <code>rustapi-rs</code>, not internal crates</li>
250+
<li><strong>Evidence over claims</strong> — benchmarks and behavior changes should be test-backed</li>
251+
<li><strong>Small, reviewable PRs</strong> — easier to merge and safer for contributors</li>
252+
<li><strong>Respectful collaboration</strong> — see the Code of Conduct</li>
247253
</ul>
248254
<h2 id="releases"><a class="header" href="#releases">Releases</a></h2>
249255
<p>Releases are tagged <code>v0.1.&lt;commit-count&gt;</code> and published to <a href="https://crates.io/crates/rustapi-rs">crates.io</a>. See <a href="../CHANGELOG.html">CHANGELOG.md</a> and <a href="../RELEASES.html">RELEASES.md</a> for notes.</p>
256+
<p><strong>Repository split:</strong> RustAPI Cloud backend development happens in <a href="https://github.com/Tuntii/RustAPI-Cloud">RustAPI-Cloud</a>. This repo ships the framework and CLI only.</p>
250257
<h2 id="security"><a class="header" href="#security">Security</a></h2>
251258
<p>Report vulnerabilities privately per <a href="../SECURITY.html">SECURITY.md</a>. Do not open public issues for undisclosed security problems.</p>
252259
<h2 id="license"><a class="header" href="#license">License</a></h2>

0 commit comments

Comments
 (0)