-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
304 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,254 @@ | ||
| <!DOCTYPE HTML> | ||
| <html lang="en" class="light" dir="ltr"> | ||
| <head> | ||
| <!-- Book generated using mdBook --> | ||
| <meta charset="UTF-8"> | ||
| <title>Contributing - The Kona Book</title> | ||
|
|
||
|
|
||
| <!-- Custom HTML head --> | ||
|
|
||
| <meta name="description" content=""> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
| <meta name="theme-color" content="#ffffff"> | ||
|
|
||
| <link rel="icon" href="favicon.svg"> | ||
| <link rel="shortcut icon" href="favicon.png"> | ||
| <link rel="stylesheet" href="css/variables.css"> | ||
| <link rel="stylesheet" href="css/general.css"> | ||
| <link rel="stylesheet" href="css/chrome.css"> | ||
| <link rel="stylesheet" href="css/print.css" media="print"> | ||
|
|
||
| <!-- Fonts --> | ||
| <link rel="stylesheet" href="FontAwesome/css/font-awesome.css"> | ||
| <link rel="stylesheet" href="fonts/fonts.css"> | ||
|
|
||
| <!-- Highlight.js Stylesheets --> | ||
| <link rel="stylesheet" href="highlight.css"> | ||
| <link rel="stylesheet" href="tomorrow-night.css"> | ||
| <link rel="stylesheet" href="ayu-highlight.css"> | ||
|
|
||
| <!-- Custom theme stylesheets --> | ||
|
|
||
| </head> | ||
| <body class="sidebar-visible no-js"> | ||
| <div id="body-container"> | ||
| <!-- Provide site root to javascript --> | ||
| <script> | ||
| var path_to_root = ""; | ||
| 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> | ||
| 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> | ||
| 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); | ||
| var body = document.querySelector('body'); | ||
| body.classList.remove('no-js') | ||
| body.classList.add('js'); | ||
| </script> | ||
|
|
||
| <input type="checkbox" id="sidebar-toggle-anchor" class="hidden"> | ||
|
|
||
| <!-- Hide / unhide sidebar before it is displayed --> | ||
| <script> | ||
| var body = document.querySelector('body'); | ||
| var sidebar = null; | ||
| var sidebar_toggle = document.getElementById("sidebar-toggle-anchor"); | ||
| if (document.body.clientWidth >= 1080) { | ||
| try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } | ||
| sidebar = sidebar || 'visible'; | ||
| } else { | ||
| sidebar = 'hidden'; | ||
| } | ||
| sidebar_toggle.checked = sidebar === 'visible'; | ||
| body.classList.remove('sidebar-visible'); | ||
| body.classList.add("sidebar-" + sidebar); | ||
| </script> | ||
|
|
||
| <nav id="sidebar" class="sidebar" aria-label="Table of contents"> | ||
| <div class="sidebar-scrollbox"> | ||
| <ol class="chapter"><li class="chapter-item expanded "><a href="intro.html"><strong aria-hidden="true">1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="fpp-dev/intro.html"><strong aria-hidden="true">2.</strong> Fault Proof Program Development</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="fpp-dev/env.html"><strong aria-hidden="true">2.1.</strong> Environment</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="fpp-dev/targets.html"><strong aria-hidden="true">2.1.1.</strong> Supported Targets</a></li></ol></li><li class="chapter-item expanded "><a href="fpp-dev/prologue.html"><strong aria-hidden="true">2.2.</strong> Prologue</a></li><li class="chapter-item expanded "><a href="fpp-dev/execution.html"><strong aria-hidden="true">2.3.</strong> Execution</a></li><li class="chapter-item expanded "><a href="fpp-dev/epilogue.html"><strong aria-hidden="true">2.4.</strong> Epilogue</a></li></ol></li><li class="chapter-item expanded "><a href="glossary.html"><strong aria-hidden="true">3.</strong> Glossary</a></li><li class="chapter-item expanded "><a href="CONTRIBUTING.html" class="active"><strong aria-hidden="true">4.</strong> Contributing</a></li></ol> | ||
| </div> | ||
| <div id="sidebar-resize-handle" class="sidebar-resize-handle"> | ||
| <div class="sidebar-resize-indicator"></div> | ||
| </div> | ||
| </nav> | ||
|
|
||
| <!-- 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> | ||
|
|
||
| <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"> | ||
| <div class="left-buttons"> | ||
| <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"> | ||
| <i class="fa fa-bars"></i> | ||
| </label> | ||
| <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</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> | ||
|
|
||
| <h1 class="menu-title">The Kona Book</h1> | ||
|
|
||
| <div class="right-buttons"> | ||
| <a href="print.html" title="Print this book" aria-label="Print this book"> | ||
| <i id="print-button" class="fa fa-print"></i> | ||
| </a> | ||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
| <div id="search-wrapper" class="hidden"> | ||
| <form id="searchbar-outer" class="searchbar-outer"> | ||
| <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header"> | ||
| </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> | ||
| 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> | ||
| <h1 id="contributing"><a class="header" href="#contributing">Contributing</a></h1> | ||
| <p>Thank you for wanting to contribute! Before contributing to this repository, please read through this document and | ||
| discuss the change you wish to make via issue or in the development telegram.</p> | ||
| <h2 id="dependencies"><a class="header" href="#dependencies">Dependencies</a></h2> | ||
| <p>Before working with this repository locally, you'll need to install several dependencies:</p> | ||
| <ul> | ||
| <li><a href="https://www.docker.com/">Docker</a> for cross-compilation.</li> | ||
| <li><a href="https://github.com/casey/just">just</a> for our command-runner scripts.</li> | ||
| <li>The <a href="https://rustup.rs/">Rust toolchain</a></li> | ||
| <li>The <a href="https://go.dev/dl/">Golang toolchain</a></li> | ||
| </ul> | ||
| <p><strong>Optional</strong></p> | ||
| <ul> | ||
| <li><a href="https://github.com/rust-lang/mdBook">mdbook</a> to contribute to the <a href="/">book</a> | ||
| <ul> | ||
| <li><a href="https://github.com/sgoudham/mdbook-template">mdbook-template</a></li> | ||
| <li><a href="https://github.com/badboy/mdbook-mermaid">mdbook-mermaid</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| <h2 id="pull-request-process"><a class="header" href="#pull-request-process">Pull Request Process</a></h2> | ||
| <ol> | ||
| <li>Before anything, <a href="https://github.com/ethereum-optimism/kona/issues/new">create an issue</a> to discuss the change you're | ||
| wanting to make, if it is significant or changes functionality. Feel free to skip this step for trivial changes.</li> | ||
| <li>Once your change is implemented, ensure that all checks are passing before creating a PR. The full CI pipeline can | ||
| be ran locally via the <code>justfile</code>s in the repository.</li> | ||
| <li>Make sure to update any documentation that has gone stale as a result of the change, in the <code>README</code> files, the [book][book], | ||
| and in rustdoc comments.</li> | ||
| <li>Once you have sign-off from a maintainer, you may merge your pull request yourself if you have permissions to do so. | ||
| If not, the maintainer who approves your pull request will add it to the merge queue.</li> | ||
| </ol> | ||
|
|
||
| </main> | ||
|
|
||
| <nav class="nav-wrapper" aria-label="Page navigation"> | ||
| <!-- Mobile navigation buttons --> | ||
| <a rel="prev" href="glossary.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> | ||
| <i class="fa fa-angle-left"></i> | ||
| </a> | ||
|
|
||
|
|
||
| <div style="clear: both"></div> | ||
| </nav> | ||
| </div> | ||
| </div> | ||
|
|
||
| <nav class="nav-wide-wrapper" aria-label="Page navigation"> | ||
| <a rel="prev" href="glossary.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> | ||
| <i class="fa fa-angle-left"></i> | ||
| </a> | ||
|
|
||
| </nav> | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <script> | ||
| window.playground_copyable = true; | ||
| </script> | ||
|
|
||
|
|
||
| <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> | ||
|
|
||
| <!-- Custom JS scripts --> | ||
| <script src="mermaid.min.js"></script> | ||
| <script src="mermaid-init.js"></script> | ||
|
|
||
|
|
||
| </div> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.