2021-02-07 03:52:57 +03:00
<!DOCTYPE HTML>
2024-05-17 13:20:03 +03:00
< html lang = "en" class = "light" dir = "ltr" >
2021-02-07 03:52:57 +03:00
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
2022-02-26 10:23:27 +03:00
< title > Contributing - Digga Library Docs< / title >
2023-01-06 06:29:52 +03:00
2021-02-07 03:52:57 +03:00
<!-- Custom HTML head -->
2023-01-06 06:29:52 +03:00
2021-02-07 03:52:57 +03:00
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2024-05-17 13:20:03 +03:00
< meta name = "theme-color" content = "#ffffff" >
2021-02-07 03:52:57 +03:00
2021-10-22 02:28:31 +03:00
< link rel = "icon" href = "favicon.svg" >
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
2021-04-19 06:33:12 +03:00
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
2021-10-22 02:28:31 +03:00
< link rel = "stylesheet" href = "css/print.css" media = "print" >
2023-01-06 06:29:52 +03:00
2021-02-07 03:52:57 +03:00
<!-- Fonts -->
2021-04-19 06:33:12 +03:00
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
2021-10-22 02:28:31 +03:00
< link rel = "stylesheet" href = "fonts/fonts.css" >
2023-01-06 06:29:52 +03:00
2021-02-07 03:52:57 +03:00
<!-- Highlight.js Stylesheets -->
2021-04-19 06:33:12 +03:00
< link rel = "stylesheet" href = "highlight.css" >
< link rel = "stylesheet" href = "tomorrow-night.css" >
< link rel = "stylesheet" href = "ayu-highlight.css" >
2021-02-07 03:52:57 +03:00
<!-- Custom theme stylesheets -->
2023-01-06 06:29:52 +03:00
2021-10-22 02:28:31 +03:00
< / head >
2024-05-17 13:20:03 +03:00
< body class = "sidebar-visible no-js" >
2023-08-08 21:11:04 +03:00
< div id = "body-container" >
2021-02-07 03:52:57 +03:00
<!-- Provide site root to javascript -->
2023-01-06 06:29:52 +03:00
< script >
2021-04-19 06:33:12 +03:00
var path_to_root = "";
2021-02-07 03:52:57 +03:00
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
2023-01-06 06:29:52 +03:00
< script >
2021-02-07 03:52:57 +03:00
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
2023-01-06 06:29:52 +03:00
< script >
2021-02-07 03:52:57 +03:00
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('light')
html.classList.add(theme);
2024-05-17 13:20:03 +03:00
var body = document.querySelector('body');
body.classList.remove('no-js')
body.classList.add('js');
2021-02-07 03:52:57 +03:00
< / script >
2024-05-17 13:20:03 +03:00
< input type = "checkbox" id = "sidebar-toggle-anchor" class = "hidden" >
2021-02-07 03:52:57 +03:00
<!-- Hide / unhide sidebar before it is displayed -->
2023-01-06 06:29:52 +03:00
< script >
2024-05-17 13:20:03 +03:00
var body = document.querySelector('body');
2023-08-08 21:11:04 +03:00
var sidebar = null;
2024-05-17 13:20:03 +03:00
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
2021-02-07 03:52:57 +03:00
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
2023-08-08 21:11:04 +03:00
} else {
sidebar = 'hidden';
2021-02-07 03:52:57 +03:00
}
2024-05-17 13:20:03 +03:00
sidebar_toggle.checked = sidebar === 'visible';
body.classList.remove('sidebar-visible');
body.classList.add("sidebar-" + sidebar);
2021-02-07 03:52:57 +03:00
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2022-07-11 01:23:28 +03:00
< ol class = "chapter" > < li class = "chapter-item expanded " > < a href = "../index.html" > < strong aria-hidden = "true" > 1.< / strong > Introduction< / a > < / li > < li class = "chapter-item expanded " > < a href = "start/index.html" > < strong aria-hidden = "true" > 2.< / strong > Quick Start< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "start/iso.html" > < strong aria-hidden = "true" > 2.1.< / strong > ISO< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "concepts/index.html" > < strong aria-hidden = "true" > 3.< / strong > Key Concepts< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "concepts/hosts.html" > < strong aria-hidden = "true" > 3.1.< / strong > Hosts< / a > < / li > < li class = "chapter-item expanded " > < a href = "concepts/overrides.html" > < strong aria-hidden = "true" > 3.2.< / strong > Overrides< / a > < / li > < li class = "chapter-item expanded " > < a href = "concepts/profiles.html" > < strong aria-hidden = "true" > 3.3.< / strong > Profiles< / a > < / li > < li class = "chapter-item expanded " > < a href = "concepts/suites.html" > < strong aria-hidden = "true" > 3.4.< / strong > Suites< / a > < / li > < li class = "chapter-item expanded " > < a href = "concepts/users.html" > < strong aria-hidden = "true" > 3.5.< / strong > Users< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "outputs/index.html" > < strong aria-hidden = "true" > 4.< / strong > Outputs< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "outputs/modules.html" > < strong aria-hidden = "true" > 4.1.< / strong > Modules< / a > < / li > < li class = "chapter-item expanded " > < a href = "outputs/overlays.html" > < strong aria-hidden = "true" > 4.2.< / strong > Overlays< / a > < / li > < li class = "chapter-item expanded " > < a href = "outputs/pkgs.html" > < strong aria-hidden = "true" > 4.3.< / strong > Packages< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < div > < strong aria-hidden = "true" > 5.< / strong > Concerns< / div > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "secrets.html" > < strong aria-hidden = "true" > 5.1.< / strong > Secrets< / a > < / li > < li class = "chapter-item expanded " > < a href = "tests.html" > < strong aria-hidden = "true" > 5.2.< / strong > Tests< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "integrations/index.html" > < strong aria-hidden = "true" > 6.< / strong > Integrations< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "integrations/cachix.html" > < strong aria-hidden = "true" > 6.1.< / strong > Cachix< / a > < / li > < li class = "chapter-item expanded " > < a href = "integrations/deploy.html" > < strong aria-hidden = "true" > 6.2.< / strong > Deploy RS< / a > < / li > < li class = "chapter-item expanded " > < a href = "integrations/nvfetcher.html" > < strong aria-hidden = "true" > 6.3.< / strong > NvFetcher< / a > < / li > < li class = "chapter-item expanded " > < a href = "integrations/hercules.html" > < strong aria-hidden = "true" > 6.4.< / strong > Hercules CI< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "api-reference.html" > < strong aria-hidden = "true" > 7.< / strong > API Reference< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "api-reference-channels.html" > < strong aria-hidden = "true" > 7.1.< / strong > Channels< / a > < / li > < li class = "chapter-item expanded " > < a href = "api-reference-home.html" > < strong aria-hidden = "true" > 7.2.< / strong > Home< / a > < / li > < li class = "chapter-item expanded " > < a href = "api-reference-devshell.html" > < strong aria-hidden = "true" > 7.3.< / strong > Devshell< / a > < / li > < li class = "chapter-item expanded " > < a href = "api-reference-nixos.html" > < strong aria-hidden = "true" > 7.4.< / strong > NixOS< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < div > < strong aria-hidden = "true" > 8.< / strong > Library Reference< / div > < / li > < li class = "chapter-item expanded " > < a href = "CONTRIBUTING.html" class = "active" > < strong aria-hidden = "true" > 9.< / strong > Contributing< / a > < / li > < / ol >
2021-10-22 02:28:31 +03:00
< / div >
2024-05-17 13:20:03 +03:00
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" >
< div class = "sidebar-resize-indicator" > < / div >
< / div >
2021-02-07 03:52:57 +03:00
< / nav >
2023-08-08 21:11:04 +03:00
<!-- Track and set sidebar scroll position -->
< script >
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
sidebarScrollbox.addEventListener('click', function(e) {
if (e.target.tagName === 'A') {
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
}
}, { passive: true });
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
sessionStorage.removeItem('sidebar-scroll');
if (sidebarScrollTop) {
// preserve sidebar scroll position when navigating via links within sidebar
sidebarScrollbox.scrollTop = sidebarScrollTop;
} else {
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
var activeSection = document.querySelector('#sidebar .active');
if (activeSection) {
activeSection.scrollIntoView({ block: 'center' });
}
}
< / script >
2021-02-07 03:52:57 +03:00
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
2023-01-06 06:29:52 +03:00
< div id = "menu-bar-hover-placeholder" > < / div >
2023-08-08 21:11:04 +03:00
< div id = "menu-bar" class = "menu-bar sticky" >
2021-02-07 03:52:57 +03:00
< div class = "left-buttons" >
2024-05-17 13:20:03 +03:00
< label id = "sidebar-toggle" class = "icon-button" for = "sidebar-toggle-anchor" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
2021-02-07 03:52:57 +03:00
< i class = "fa fa-bars" > < / i >
2024-05-17 13:20:03 +03:00
< / label >
2021-02-07 03:52:57 +03:00
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
2023-01-06 06:29:52 +03:00
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light< / button > < / li >
2021-02-07 03:52:57 +03:00
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< / ul >
2021-10-22 02:28:31 +03:00
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
2021-02-07 03:52:57 +03:00
< i class = "fa fa-search" > < / i >
< / button >
2021-10-22 02:28:31 +03:00
< / div >
2021-02-07 03:52:57 +03:00
2022-02-26 10:23:27 +03:00
< h1 class = "menu-title" > Digga Library Docs< / h1 >
2021-02-07 03:52:57 +03:00
< div class = "right-buttons" >
2021-10-22 02:28:31 +03:00
< a href = "print.html" title = "Print this book" aria-label = "Print this book" >
2021-02-07 03:52:57 +03:00
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
2023-01-06 06:29:52 +03:00
2021-02-07 03:52:57 +03:00
< / div >
< / div >
2021-10-22 02:28:31 +03:00
< div id = "search-wrapper" class = "hidden" >
2021-02-07 03:52:57 +03:00
< form id = "searchbar-outer" class = "searchbar-outer" >
2021-05-15 07:26:00 +03:00
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
2021-02-07 03:52:57 +03:00
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
2023-01-06 06:29:52 +03:00
2021-02-07 03:52:57 +03:00
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
2023-01-06 06:29:52 +03:00
< script >
2021-02-07 03:52:57 +03:00
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
2022-02-26 10:23:27 +03:00
< h1 id = "tldr" > < a class = "header" href = "#tldr" > TL;DR;< / a > < / h1 >
2021-02-15 03:36:17 +03:00
< ul >
2021-10-22 02:28:31 +03:00
< li > < strong > Target Branch< / strong > : < code > main< / code > < / li >
2022-04-01 21:14:16 +03:00
< li > < strong > Merge Policy< / strong > : green check: merge away. yellow circle: have patience. red x: try again.< / li >
2022-02-26 10:23:27 +03:00
< li > < strong > Docs< / strong > : every change set is expected to contain doc updates< / li >
2022-11-12 14:02:44 +03:00
< li > < strong > Commit Msg< / strong > : be a poet! Comprehensive and explanatory commit messages
2021-08-02 00:40:04 +03:00
should cover the motivation and use case in an easily understandable manner
even when read after a few months.< / li >
2022-02-26 10:23:27 +03:00
< li > < strong > Test Driven Development< / strong > : please default to test driven development you can
2022-11-12 14:02:44 +03:00
make use of the < code > ./examples< / code > & < code > ./e2e< / code > and wire test up in the devshell.< / li >
2021-08-02 00:40:04 +03:00
< / ul >
< h3 id = "within-the-devshell-nix-develop" > < a class = "header" href = "#within-the-devshell-nix-develop" > Within the Devshell (< code > nix develop< / code > )< / a > < / h3 >
< ul >
< li > < strong > Hooks< / strong > : please < code > git commit< / code > within the devshell< / li >
2022-02-26 10:23:27 +03:00
< li > < strong > Fail Early< / strong > : please run < code > check-all< / code > from within the devshell on your local machine< / li >
2021-02-15 03:36:17 +03:00
< / ul >
2021-02-07 03:52:57 +03:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2022-02-26 10:23:27 +03:00
< a rel = "prev" href = "api-reference-nixos.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-02-15 03:36:17 +03:00
< i class = "fa fa-angle-left" > < / i >
2021-02-07 03:52:57 +03:00
< / a >
2023-01-06 06:29:52 +03:00
2021-02-07 03:52:57 +03:00
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
2022-02-26 10:23:27 +03:00
< a rel = "prev" href = "api-reference-nixos.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-02-15 03:36:17 +03:00
< i class = "fa fa-angle-left" > < / i >
2021-02-07 03:52:57 +03:00
< / a >
2023-01-06 06:29:52 +03:00
2021-10-22 02:28:31 +03:00
< / nav >
2021-02-07 03:52:57 +03:00
< / div >
2023-01-06 06:29:52 +03:00
< script >
2021-02-07 03:52:57 +03:00
window.playground_copyable = true;
< / script >
2023-01-06 06:29:52 +03:00
< script src = "elasticlunr.min.js" > < / script >
< script src = "mark.min.js" > < / script >
< script src = "searcher.js" > < / script >
< script src = "clipboard.min.js" > < / script >
< script src = "highlight.js" > < / script >
< script src = "book.js" > < / script >
2021-02-07 03:52:57 +03:00
<!-- Custom JS scripts -->
2023-01-06 06:29:52 +03:00
2023-08-08 21:11:04 +03:00
< / div >
2021-02-07 03:52:57 +03:00
< / body >
< / html >
