65 lines
3.8 KiB
HTML
65 lines
3.8 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<title>Contribute — Keru OS</title>
|
|
<meta name="description" content="How to contribute to Keru OS: recipes, the installer, the package manager, docs, and the website.">
|
|
<link rel="stylesheet" href="assets/css/style.css">
|
|
<link rel="icon" href="data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100'><text y='.9em' font-size='90'>ける</text></svg>">
|
|
</head>
|
|
<body>
|
|
|
|
<nav class="top" data-nav></nav>
|
|
|
|
<header class="pagehead">
|
|
<p class="crumbs"><a href="index.html">home</a> / <a href="community.html">community</a> / contribute</p>
|
|
<h1>Contribute</h1>
|
|
<p>There's no gatekeeping. There's work to do.</p>
|
|
</header>
|
|
|
|
<section>
|
|
<div class="wrap">
|
|
<div class="prose">
|
|
<p>Keru is small and early, which means contributions are unusually consequential. A recipe you write may be the one a whole filesystem choice builds on. Here's how to get in.</p>
|
|
|
|
<h3>Where things live</h3>
|
|
<table>
|
|
<tr><th>Repo</th><th>You'd contribute</th></tr>
|
|
<tr><td>KeruOS</td><td>Installer, profile, scripts, live init, docs, and this website.</td></tr>
|
|
<tr><td>kama</td><td>The package manager itself — and, ideally, not much. It's meant to stay small.</td></tr>
|
|
<tr><td>kama-packages</td><td>Recipes — the highest-leverage place. Busybox, runit, and a template exist.</td></tr>
|
|
</table>
|
|
|
|
<h3>Ways to help</h3>
|
|
<ul class="features">
|
|
<li><strong>Write recipes.</strong> A <code><pkg>.sh</code> in <code>kama-packages</code> is a package. Start from <code>TEMPLATE.sh</code>. <a href="recipe-format.html">The format is small.</a></li>
|
|
<li><strong>Test the toolchain bootstrap.</strong> The stage-0 build (gcc/glibc from nothing) is the riskiest seam; hands on real machines are gold.</li>
|
|
<li><strong>Sharpen the installer.</strong> Menu UX, network handling, stability checks — all open.</li>
|
|
<li><strong>Fix bugs.</strong> The road to 0.1 is literally a list of bugs between here and a booting ISO.</li>
|
|
<li><strong>Docs & site.</strong> This website lives in its own repo, <code>github.com/AstralZX/keru</code> — plain HTML, no framework. Improving it is plain work on plain files.</li>
|
|
</ul>
|
|
|
|
<h3>Ground rules</h3>
|
|
<ul class="features">
|
|
<li><strong>Match the ethos.</strong> Source-only, no opinion, small pieces. A PR that adds a dependency resolver to kama contradicts the project's spine.</li>
|
|
<li><strong>Stay legible.</strong> If shell can do it plainly, don't introduce machinery.</li>
|
|
<li><strong>Honesty at the edges.</strong> Unproven combinations go in with a warning, or not at all — never silently.</li>
|
|
<li><strong>AGPL-3.0.</strong> All three repos are AGPL-3.0; contributions fall under it.</li>
|
|
</ul>
|
|
|
|
<h3>Where to start</h3>
|
|
<p>Issues, recipe ideas, and bug reports live on the <a href="links.html">three repositories</a>, and discussion on the <a href="contact.html">contact channels</a>. If you're looking for a first move: pick a recipe, read <code>TEMPLATE.sh</code>, and send it.</p>
|
|
|
|
<div class="callout">A small distribution values every PR — there's no pile to get lost in. What you send is likely to matter.</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<footer data-footer></footer>
|
|
|
|
<noscript><div style="text-align:center;padding:16px">See the <a href="sitemap.html">sitemap</a> for all pages.</div></noscript>
|
|
|
|
<script src="assets/js/include.js" data-base="."></script>
|
|
</body>
|
|
</html> |