2021-02-07 03:52:57 +03:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
2021-02-18 04:42:21 +03:00
< title > Contributing - devos docs< / title >
2021-02-07 03:52:57 +03:00
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
2021-04-19 06:33:12 +03:00
< link rel = "icon" href = "favicon.svg" >
2021-02-07 03:52:57 +03:00
2021-04-19 06:33:12 +03:00
< link rel = "shortcut icon" href = "favicon.png" >
2021-02-07 03:52:57 +03:00
2021-04-19 06:33:12 +03:00
< link rel = "stylesheet" href = "css/variables.css" >
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
2021-02-07 03:52:57 +03:00
2021-04-19 06:33:12 +03:00
< link rel = "stylesheet" href = "css/print.css" media = "print" >
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-02-07 03:52:57 +03:00
2021-04-19 06:33:12 +03:00
< link rel = "stylesheet" href = "fonts/fonts.css" >
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 -->
< / head >
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
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 -->
< script type = "text/javascript" >
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 -->
< script type = "text/javascript" >
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('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2021-04-19 06:33:12 +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 > < li class = "chapter-item expanded " > < a href = "start/bootstrapping.html" > < strong aria-hidden = "true" > 2.2.< / strong > Bootstrapping< / a > < / li > < li class = "chapter-item expanded " > < a href = "start/from-nixos.html" > < strong aria-hidden = "true" > 2.3.< / strong > From NixOS< / 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/extern.html" > < strong aria-hidden = "true" > 3.1.< / strong > Extern< / a > < / li > < li class = "chapter-item expanded " > < a href = "concepts/hosts.html" > < strong aria-hidden = "true" > 3.2.< / strong > Hosts< / a > < / li > < li class = "chapter-item expanded " > < a href = "concepts/overrides.html" > < strong aria-hidden = "true" > 3.3.< / strong > Overrides< / a > < / li > < li class = "chapter-item expanded " > < a href = "concepts/profiles.html" > < strong aria-hidden = "true" > 3.4.< / strong > Profiles< / a > < / li > < li class = "chapter-item expanded " > < a href = "concepts/suites.html" > < strong aria-hidden = "true" > 3.5.< / strong > Suites< / a > < / li > < li class = "chapter-item expanded " > < a href = "concepts/users.html" > < strong aria-hidden = "true" > 3.6.< / 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 = "lib.html" > < strong aria-hidden = "true" > 5.1.< / strong > Lib< / a > < / li > < li class = "chapter-item expanded " > < a href = "secrets.html" > < strong aria-hidden = "true" > 5.2.< / strong > Secrets< / a > < / li > < li class = "chapter-item expanded " > < a href = "tests.html" > < strong aria-hidden = "true" > 5.3.< / strong > Tests< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "flk/index.html" > < strong aria-hidden = "true" > 6.< / strong > Helper Script – < / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "flk/up.html" > < strong aria-hidden = "true" > 6.1.< / strong > up< / a > < / li > < li class = "chapter-item expanded " > < a href = "flk/update.html" > < strong aria-hidden = "true" > 6.2.< / strong > update< / a > < / li > < li class = "chapter-item expanded " > < a href = "flk/get.html" > < strong aria-hidden = "true" > 6.3.< / strong > get< / a > < / li > < li class = "chapter-item expanded " > < a href = "flk/iso.html" > < strong aria-hidden = "true" > 6.4.< / strong > iso< / a > < / li > < li class = "chapter-item expanded " > < a href = "flk/install.html" > < strong aria-hidden = "true" > 6.5.< / strong > install< / a > < / li > < li class = "chapter-item expanded " > < a href = "flk/home.html" > < strong aria-hidden = "true" > 6.6.< / strong > home< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "integrations/index.html" > < strong aria-hidden = "true" > 7.< / strong > Integrations< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "integrations/cachix.html" > < strong aria-hidden = "true" > 7.1.< / strong > Cachix< / a > < / li > < li class = "chapter-item expanded " > < a href = "integrations/deploy.html" > < strong aria-hidden = "true" > 7.2.< / strong > Deploy RS< / a > < / li > < li class = "chapter-item expanded " > < a href = "integrations/hercules.html" > < strong aria-hidden = "true" > 7.3.< / strong > Hercules CI< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "CONTRIBUTING.html" class = "active" > < strong aria-hidden = "true" > 8.< / strong > Contributing< / a > <
2021-02-07 03:52:57 +03:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< 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" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light (default)< / button > < / li >
< 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 >
< 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" >
< i class = "fa fa-search" > < / i >
< / button >
< / div >
2021-02-18 04:42:21 +03:00
< h1 class = "menu-title" > devos docs< / h1 >
2021-02-07 03:52:57 +03:00
< div class = "right-buttons" >
2021-04-19 06:33:12 +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 >
2021-05-15 07:26:00 +03:00
2021-02-07 03:52:57 +03:00
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< 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 >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
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 >
2021-02-26 00:56:38 +03:00
< h1 id = "pull-requests" > < a class = "header" href = "#pull-requests" > Pull Requests< / a > < / h1 >
2021-02-15 03:36:17 +03:00
< p > If making a change to core, or adding a feature, please be sure to update the
relevant docs. Each directory contains its own README.md, which will
2021-02-18 07:03:36 +03:00
automatically be pulled into the < a href = "https://devos.divnix.com" > mdbook< / a > . The book is
2021-02-15 03:36:17 +03:00
rendered on every change, so the docs should always be up to date.< / p >
2021-03-14 10:12:02 +03:00
< p > We also use < a href = "https://bors.tech" > BORS< / a > to ensure that all pull requests pass the
test suite once at least one review is completed.< / p >
2021-02-26 00:56:38 +03:00
< h2 id = "community-prs" > < a class = "header" href = "#community-prs" > Community PRs< / a > < / h2 >
2021-02-15 03:36:17 +03:00
< p > While much of your work in this template may be idiosyncratic in nature. Anything
that might be generally useful to the broader NixOS community can be synced to
the < code > community< / code > branch to provide a host of useful NixOS configurations available
" out of the box" .< / p >
2021-02-26 00:56:38 +03:00
< h1 id = "style" > < a class = "header" href = "#style" > Style< / a > < / h1 >
2021-02-15 03:36:17 +03:00
< p > If you wish to contribute please follow these guidelines:< / p >
< ul >
< li >
< p > format your code with < a href = "https://github.com/nix-community/nixpkgs-fmt" > < code > nixpkgs-fmt< / code > < / a > . The default devshell
includes a pre-commit hook that does this for you.< / p >
< / li >
< li >
< p > The commit message follows the same semantics as < a href = "https://github.com/NixOS/nixpkgs" > nixpkgs< / a > .< / p >
< ul >
< li > You can use a < code > #< / code > symbol to specify ambiguities. For example,
2021-04-23 06:45:18 +03:00
< code > develop#zsh: < rest of commit message> < / code > would tell me that you're updating the
2021-02-15 03:36:17 +03:00
< code > zsh< / code > subprofile living under the < code > develop< / code > profile.< / li >
< / ul >
< / li >
< / ul >
2021-02-07 03:52:57 +03:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2021-04-19 06:33:12 +03:00
< a rel = "prev" href = "integrations/hercules.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 >
2021-02-15 03:36:17 +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" >
2021-04-19 06:33:12 +03:00
< a rel = "prev" href = "integrations/hercules.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 >
2021-02-15 03:36:17 +03:00
2021-02-07 03:52:57 +03:00
< / nav >
< / div >
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
2021-04-19 06:33:12 +03:00
< script src = "elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
2021-02-07 03:52:57 +03:00
2021-04-19 06:33:12 +03:00
< script src = "clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "book.js" type = "text/javascript" charset = "utf-8" > < / script >
2021-02-07 03:52:57 +03:00
<!-- Custom JS scripts -->
< / body >
< / html >
