GitHub - fandango-fuzzer/fandango-fuzzer.github.io: Repository hosting the Fandango Fuzzer documentation

fandango-fuzzer / fandango-fuzzer.github.io Public
Notifications You must be signed in to change notification settings
Fork 0
Star 0
Repository hosting the Fandango Fuzzer documentation
fandango-fuzzer.github.io/
Notifications
Name		Name	Last commit message	Last commit date
Latest commit History 50 Commits
_downloads		_downloads
_images		_images
_sources		_sources
_sphinx_design_static		_sphinx_design_static
_static		_static
reports		reports
.nojekyll		.nojekyll
About.html		About.html
About.html.orig		About.html.orig
Binary.html		Binary.html
Binary.html.orig		Binary.html.orig
Bits.html		Bits.html
Bits.html.orig		Bits.html.orig
Commands.html		Commands.html
Commands.html.orig		Commands.html.orig
Constraints.html		Constraints.html
Constraints.html.orig		Constraints.html.orig
Contributing.html		Contributing.html
Contributing.html.orig		Contributing.html.orig
Conversion.html		Conversion.html
Conversion.html.orig		Conversion.html.orig
Converters.html		Converters.html
DerivationTree.html		DerivationTree.html
DerivationTree.html.orig		DerivationTree.html.orig
Distributions.html		Distributions.html
Distributions.html.orig		Distributions.html.orig
FAQ.html		FAQ.html
FAQ.html.orig		FAQ.html.orig
FAQ.html.rej		FAQ.html.rej
FirstSpec.html		FirstSpec.html
FirstSpec.html.orig		FirstSpec.html.orig
Footer.html		Footer.html
Footer.html.orig		Footer.html.orig
Fuzzing.html		Fuzzing.html
Fuzzing.html.orig		Fuzzing.html.orig
Generators.html		Generators.html
Generators.html.orig		Generators.html.orig
Gif.html		Gif.html
Gif.html.orig		Gif.html.orig
Hatching.html		Hatching.html
Hatching.html.orig		Hatching.html.orig
ISO8601.html		ISO8601.html
ISO8601.html.orig		ISO8601.html.orig
Including.html		Including.html
Including.html.orig		Including.html.orig
Installing.html		Installing.html
Installing.html.orig		Installing.html.orig
Intro.html		Intro.html
Intro.html.orig		Intro.html.orig
Invoking.html		Invoking.html
Invoking.html.orig		Invoking.html.orig
Language.html		Language.html
Language.html.orig		Language.html.orig
LanguageServer.html		LanguageServer.html
LanguageServer.html.orig		LanguageServer.html.orig
Outputs.html		Outputs.html
Parsing.html		Parsing.html
Parsing.html.orig		Parsing.html.orig
Paths.html		Paths.html
Paths.html.orig		Paths.html.orig
Protocols.html		Protocols.html
PythonAPI.html		PythonAPI.html
PythonAPI.html.orig		PythonAPI.html.orig
Recursive.html		Recursive.html
Recursive.html.orig		Recursive.html.orig
Reference.html		Reference.html
Reference.html.orig		Reference.html.orig
Regexes.html		Regexes.html
Regexes.html.orig		Regexes.html.orig
ReleaseNotes.html		ReleaseNotes.html
ReleaseNotes.html.orig		ReleaseNotes.html.orig
Setup.html		Setup.html
Setup.html.orig		Setup.html.orig
Shell.html		Shell.html
Shell.html.orig		Shell.html.orig
Stdlib.html		Stdlib.html
Stdlib.html.orig		Stdlib.html.orig
Strategies.html		Strategies.html
Strategies.html.orig		Strategies.html.orig
Tutorial.html		Tutorial.html
Tutorial.html.orig		Tutorial.html.orig
Whitebox.html		Whitebox.html
Whitebox.html.orig		Whitebox.html.orig
all-marker.txt		all-marker.txt
genindex.html		genindex.html
index.html		index.html
marker.txt		marker.txt
objects.inv		objects.inv
search.html		search.html
searchindex.js		searchindex.js
Repository files navigation

<!DOCTYPE html>


<html lang="en" data-content_root="./" >

  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

    <title>Contributing to Fandango &#8212; Fuzzing with Fandango</title>
  
  
  
  <script data-cfasync="false">
    document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
    document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
  </script>
  
  <!-- Loaded before other Sphinx assets -->
  <link href="_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />

  
  <link href="_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
  <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />

    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
    <link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
    <link rel="stylesheet" type="text/css" href="_static/togglebutton.css?v=13237357" />
    <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
    <link rel="stylesheet" type="text/css" href="_static/mystnb.8ecb98da25f57f5357bf6f572d296f466b2cfe2517ffebfabe82451661e28f02.css" />
    <link rel="stylesheet" type="text/css" href="_static/sphinx-thebe.css?v=4fa983c6" />
    <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
  
  <!-- Pre-loaded scripts that we'll load fully later -->
  <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
  <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>

    <script src="_static/documentation_options.js?v=9eb32ce0"></script>
    <script src="_static/doctools.js?v=9a2dae69"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="_static/copybutton.js?v=f281be69"></script>
    <script src="_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
    <script>let toggleHintShow = 'Click to show';</script>
    <script>let toggleHintHide = 'Click to hide';</script>
    <script>let toggleOpenOnPrint = 'true';</script>
    <script src="_static/togglebutton.js?v=4a39c7ea"></script>
    <script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
    <script src="_static/design-tabs.js?v=f930bc37"></script>
    <script>const THEBE_JS_URL = "https://unpkg.com/[email protected]/lib/index.js"; const thebe_selector = ".thebe,.cell"; const thebe_selector_input = "pre"; const thebe_selector_output = ".output, .cell_output"</script>
    <script async="async" src="_static/sphinx-thebe.js?v=c100c467"></script>
    <script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
    <script>const THEBE_JS_URL = "https://unpkg.com/[email protected]/lib/index.js"; const thebe_selector = ".thebe,.cell"; const thebe_selector_input = "pre"; const thebe_selector_output = ".output, .cell_output"</script>
    <script>DOCUMENTATION_OPTIONS.pagename = 'Contributing';</script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Fandango Tutorial" href="Tutorial.html" />
    <link rel="prev" title="Fandango FAQ" href="FAQ.html" />
  <meta name="viewport" content="width=device-width, initial-scale=1"/>
  <meta name="docsearch:language" content="en"/>
  </head>
  
  
  <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">

  
  
  <div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
  
  <div id="pst-scroll-pixel-helper"></div>
  
  <button type="button" class="btn rounded-pill" id="pst-back-to-top">
    <i class="fa-solid fa-arrow-up"></i>Back to top</button>

  
  <input type="checkbox"
          class="sidebar-toggle"
          id="pst-primary-sidebar-checkbox"/>
  <label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label>
  
  <input type="checkbox"
          class="sidebar-toggle"
          id="pst-secondary-sidebar-checkbox"/>
  <label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label>
  
  <div class="search-button__wrapper">
    <div class="search-button__overlay"></div>
    <div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
      action="search.html"
      method="get">
  <i class="fa-solid fa-magnifying-glass"></i>
  <input type="search"
         class="form-control"
         name="q"
         id="search-input"
         placeholder="Search this book..."
         aria-label="Search this book..."
         autocomplete="off"
         autocorrect="off"
         autocapitalize="off"
         spellcheck="false"/>
  <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
  </div>

  <div class="pst-async-banner-revealer d-none">
  <aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>

  
    <header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
    </header>
  

  <div class="bd-container">
    <div class="bd-container__inner bd-page-width">
      
      
      
      <div class="bd-sidebar-primary bd-sidebar">
        

  
  <div class="sidebar-header-items sidebar-primary__section">
    
    
    
    
  </div>
  
    <div class="sidebar-primary-items__start sidebar-primary__section">
        <div class="sidebar-primary-item">

  
    
  

<a class="navbar-brand logo" href="Intro.html">
  
  
  
  
  
    
    
      
    
    
    <img src="_static/fandango.png" class="logo__image only-light" alt="Fuzzing with Fandango - Home"/>
    <script>document.write(`<img src="_static/fandango.png" class="logo__image only-dark" alt="Fuzzing with Fandango - Home"/>`);</script>
  
  
</a></div>
        <div class="sidebar-primary-item">

 <script>
 document.write(`
   <button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <i class="fa-solid fa-magnifying-glass"></i>
    <span class="search-button__default-text">Search</span>
    <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
   </button>
 `);
 </script></div>
        <div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
    <div class="bd-toc-item navbar-nav active">
        
        <ul class="nav bd-sidenav bd-sidenav__home-link">
            <li class="toctree-l1">
                <a class="reference internal" href="Intro.html">
                    Fuzzing with Fandango
                </a>
            </li>
        </ul>
        <p aria-level="2" class="caption" role="heading"><span class="caption-text">About Fandango</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="About.html">About Fandango</a></li>
<li class="toctree-l1"><a class="reference internal" href="ReleaseNotes.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="FAQ.html">Fandango FAQ</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Contributing to Fandango</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Fandango Tutorial</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="Tutorial.html">Fandango Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="Setup.html">Installing Fandango</a></li>
<li class="toctree-l1"><a class="reference internal" href="FirstSpec.html">A First Fandango Spec</a></li>
<li class="toctree-l1"><a class="reference internal" href="Invoking.html">Invoking Fandango</a></li>
<li class="toctree-l1"><a class="reference internal" href="Fuzzing.html">Fuzzing with Fandango</a></li>
<li class="toctree-l1"><a class="reference internal" href="Strategies.html">Some Fuzzing Strategies</a></li>
<li class="toctree-l1"><a class="reference internal" href="Constraints.html">Shaping Inputs with Constraints</a></li>
<li class="toctree-l1"><a class="reference internal" href="Shell.html">The Fandango Shell</a></li>
<li class="toctree-l1"><a class="reference internal" href="Generators.html">Data Generators and Fakers</a></li>
<li class="toctree-l1"><a class="reference internal" href="Regexes.html">Regular Expressions</a></li>
<li class="toctree-l1"><a class="reference internal" href="Recursive.html">Complex Input Structures</a></li>
<li class="toctree-l1"><a class="reference internal" href="Paths.html">Accessing Input Elements</a></li>
<li class="toctree-l1"><a class="reference internal" href="ISO8601.html">Case Study: ISO 8601 Date + Time</a></li>
<li class="toctree-l1"><a class="reference internal" href="Converters.html">Converting ANTLR and Other Input Specs</a></li>
<li class="toctree-l1"><a class="reference internal" href="Parsing.html">Parsing Inputs</a></li>
<li class="toctree-l1"><a class="reference internal" href="Outputs.html">Checking Outputs</a></li>
<li class="toctree-l1"><a class="reference internal" href="Binary.html">Generating Binary Inputs</a></li>
<li class="toctree-l1"><a class="reference internal" href="Bits.html">Bits and Bit Fields</a></li>
<li class="toctree-l1"><a class="reference internal" href="Gif.html">Case Study: The GIF Format</a></li>
<li class="toctree-l1"><a class="reference internal" href="Conversion.html">Data Converters</a></li>
<li class="toctree-l1"><a class="reference internal" href="Protocols.html">Testing Protocols</a></li>
<li class="toctree-l1"><a class="reference internal" href="Hatching.html">Hatching Specs</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Fandango Reference</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="Reference.html">Fandango Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installing.html">Installing Fandango</a></li>
<li class="toctree-l1"><a class="reference internal" href="Commands.html">Fandango Command Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="Language.html">Fandango Language Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="Stdlib.html">Fandango Standard Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="DerivationTree.html">Derivation Tree Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="PythonAPI.html">Python API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="Including.html">Fandango File Locations</a></li>
<li class="toctree-l1"><a class="reference internal" href="LanguageServer.html">Fandango Language Server</a></li>
</ul>

    </div>
</nav></div>
    </div>
  
  
  <div class="sidebar-primary-items__end sidebar-primary__section">
  </div>
  
  <div id="rtd-footer-container"></div>


      </div>
      
      <main id="main-content" class="bd-main" role="main">
        
        

<div class="sbt-scroll-pixel-helper"></div>

          <div class="bd-content">
            <div class="bd-article-container">
              
              <div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
  
    <div class="header-article-items__start">
      
        <div class="header-article-item"><button class="sidebar-toggle primary-toggle btn btn-sm" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
  <span class="fa-solid fa-bars"></span>
</button></div>
      
    </div>
  
  
    <div class="header-article-items__end">
      
        <div class="header-article-item">

<div class="article-header-buttons">





<div class="dropdown dropdown-source-buttons">
  <button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Source repositories">
    <i class="fab fa-github"></i>
  </button>
  <ul class="dropdown-menu">
      
      
      
      <li><a href="https://github.com/fandango-fuzzer/fandango" target="_blank"
   class="btn btn-sm btn-source-repository-button dropdown-item"
   title="Source repository"
   data-bs-placement="left" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fab fa-github"></i>
  </span>
<span class="btn__text-container">Repository</span>
</a>
</li>
      
      
      
      
      <li><a href="https://github.com/fandango-fuzzer/fandango/issues/new?title=Issue%20on%20page%20%2FContributing.html&body=Your%20issue%20content%20here." target="_blank"
   class="btn btn-sm btn-source-issues-button dropdown-item"
   title="Open an issue"
   data-bs-placement="left" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fas fa-lightbulb"></i>
  </span>
<span class="btn__text-container">Open issue</span>
</a>
</li>
      
  </ul>
</div>






<div class="dropdown dropdown-download-buttons">
  <button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Download this page">
    <i class="fas fa-download"></i>
  </button>
  <ul class="dropdown-menu">
      
      
      
      <li><a href="_sources/Contributing.md" target="_blank"
   class="btn btn-sm btn-download-source-button dropdown-item"
   title="Download source file"
   data-bs-placement="left" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fas fa-file"></i>
  </span>
<span class="btn__text-container">.md</span>
</a>
</li>
      
      
      
      
      <li>
<button onclick="window.print()"
  class="btn btn-sm btn-download-pdf-button dropdown-item"
  title="Print to PDF"
  data-bs-placement="left" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fas fa-file-pdf"></i>
  </span>
<span class="btn__text-container">.pdf</span>
</button>
</li>
      
  </ul>
</div>




<button onclick="toggleFullScreen()"
  class="btn btn-sm btn-fullscreen-button"
  title="Fullscreen mode"
  data-bs-placement="bottom" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fas fa-expand"></i>
  </span>

</button>



<script>
document.write(`
  <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
    <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
    <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
  </button>
`);
</script>


<script>
document.write(`
  <button class="btn btn-sm pst-navbar-icon search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <i class="fa-solid fa-magnifying-glass fa-lg"></i>
  </button>
`);
</script>
<button class="sidebar-toggle secondary-toggle btn btn-sm" title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <span class="fa-solid fa-list"></span>
</button>
</div></div>
      
    </div>
  
</div>
</div>
              
              

<div id="jb-print-docs-body" class="onlyprint">
    <h1>Contributing to Fandango</h1>
    <!-- Table of contents -->
    <div id="print-main-content">
        <div id="jb-print-toc">
            
            <div>
                <h2> Contents </h2>
            </div>
            <nav aria-label="Page">
                <ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#code-of-conduct">Code of Conduct</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#getting-started-with-development">Getting Started with Development</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-1-fork-the-fandango-repository">Step 1: Fork the Fandango repository</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-2-clone-the-fandango-repository-and-enter-into-it">Step 2: Clone the Fandango repository and enter into it</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-3-create-then-activate-a-virtual-environment">Step 3: Create, then activate a virtual environment</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-4-install-development-tools">Step 4: Install development tools</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-5-install-fandango">Step 5: Install Fandango</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#running-tests">Running Tests</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pre-commit">Pre-commit</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#first-time-contributors">First Time Contributors</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#contributing-code">Contributing Code</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#changing-parser-files">Changing Parser Files</a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#step-1-generate-the-parser-code">Step 1: Generate the parser code</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#step-2-compile-the-parser-code">Step 2: Compile the parser code</a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#contributing-to-documentation">Contributing to Documentation</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#attributions">Attributions</a></li>
</ul>
            </nav>
        </div>
    </div>
</div>

              
                
<div id="searchbox"></div>
                <article class="bd-article">
                  
  <section class="tex2jax_ignore mathjax_ignore" id="contributing-to-fandango">
<span id="sec-contributing"></span><h1>Contributing to Fandango<a class="headerlink" href="#contributing-to-fandango" title="Link to this heading">#</a></h1>
<p>Welcome!
Fandango is a community project that aims to work for a wide
range of developers.
If you’re trying out Fandango, your experience and what you can contribute are
important to the project’s success.</p>
<section id="code-of-conduct">
<span id="sec-code-of-conduct"></span><h2>Code of Conduct<a class="headerlink" href="#code-of-conduct" title="Link to this heading">#</a></h2>
<p>Everyone participating in Fandango, and in particular in our
issue tracker, pull requests, and chat, is expected to treat
other people with respect and more generally to follow the guidelines
articulated in the <a class="reference external" href="https://www.python.org/psf/codeofconduct/">Python Community Code of Conduct</a>.</p>
</section>
<section id="getting-started-with-development">
<span id="sec-getting-started-with-development"></span><h2>Getting Started with Development<a class="headerlink" href="#getting-started-with-development" title="Link to this heading">#</a></h2>
<section id="step-1-fork-the-fandango-repository">
<h3>Step 1: Fork the Fandango repository<a class="headerlink" href="#step-1-fork-the-fandango-repository" title="Link to this heading">#</a></h3>
<p>Within GitHub, navigate to the <a class="reference external" href="https://github.com/fandango-fuzzer/fandango">Fandango GitHub repository</a> and fork the repository.</p>
</section>
<section id="step-2-clone-the-fandango-repository-and-enter-into-it">
<h3>Step 2: Clone the Fandango repository and enter into it<a class="headerlink" href="#step-2-clone-the-fandango-repository-and-enter-into-it" title="Link to this heading">#</a></h3>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/fandango-fuzzer/fandango.git
</pre></div>
</div>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>fandango
</pre></div>
</div>
</section>
<section id="step-3-create-then-activate-a-virtual-environment">
<h3>Step 3: Create, then activate a virtual environment<a class="headerlink" href="#step-3-create-then-activate-a-virtual-environment" title="Link to this heading">#</a></h3>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>python3<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>venv
</pre></div>
</div>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="nb">source</span><span class="w"> </span>venv/bin/activate
</pre></div>
</div>
<p>For Windows, use</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>venv
</pre></div>
</div>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>.<span class="w"> </span>venv/Scripts/activate
</pre></div>
</div>
<p>For more details, see <a class="reference external" href="https://docs.python.org/3/library/venv.html#creating-virtual-environments">https://docs.python.org/3/library/venv.html#creating-virtual-environments</a></p>
</section>
<section id="step-4-install-development-tools">
<h3>Step 4: Install development tools<a class="headerlink" href="#step-4-install-development-tools" title="Link to this heading">#</a></h3>
<p>Install <code class="docutils literal notranslate"><span class="pre">antlr</span></code> and other system-level tools:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>make<span class="w"> </span>system-dev-tools
</pre></div>
</div>
</section>
<section id="step-5-install-fandango">
<span id="sec-pip-install"></span><h3>Step 5: Install Fandango<a class="headerlink" href="#step-5-install-fandango" title="Link to this heading">#</a></h3>
<p>Install your local copy of Fandango:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
</pre></div>
</div>
<p>To install additional dependencies for unit tests, code checks, running the evaluation, and building the Fandango book, install Fandango like this (or with the subsection of dependencies you need):</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span><span class="s2">&quot;.[test,development,evaluation,book]&quot;</span>
</pre></div>
</div>
<p>If you don’t need the (much faster) C++ parser, build Fandango without:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="nv">FANDANGO_SKIP_CPP_PARSER</span><span class="o">=</span><span class="m">1</span><span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
</pre></div>
</div>
<p>Reset the shell PATH cache (not necessary on Windows):</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="nb">hash</span><span class="w"> </span>-r
</pre></div>
</div>
<p>That’s it! You just have installed your personal copy of Fandango.
You can invoke it as <code class="docutils literal notranslate"><span class="pre">fandango</span></code> and can alter its code as you like.</p>
</section>
</section>
<section id="running-tests">
<span id="sec-running-tests"></span><h2>Running Tests<a class="headerlink" href="#running-tests" title="Link to this heading">#</a></h2>
<p>Running the full test suite can take a while, and usually is not necessary when
preparing a pull request.
Once you file a pull request, the full test suite will run on GitHub.
You’ll then be able to see any test failures, and make any necessary changes to
your pull request.</p>
<p>However, if you wish to do so, you can run the full test suite
like this:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>make<span class="w"> </span>tests
</pre></div>
</div>
<p>or simply</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pytest
</pre></div>
</div>
<p>To run tests in parallel, you can use <a class="reference external" href="https://pytest-xdist.readthedocs.io/en/stable/">pytest-xdist</a> (installed with the <code class="docutils literal notranslate"><span class="pre">test</span></code> depenendencies):</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pytest<span class="w"> </span>-n<span class="w"> </span>auto
</pre></div>
</div>
<section id="pre-commit">
<h3>Pre-commit<a class="headerlink" href="#pre-commit" title="Link to this heading">#</a></h3>
<p>Fandango provides a config file for <code class="docutils literal notranslate"><span class="pre">pre-commit</span></code>. To install it, run the following:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>pre-commit
$<span class="w"> </span>pre-commit<span class="w"> </span>install
</pre></div>
</div>
<p>This will run code formatting and type checking before every commit.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>The <a class="reference internal" href="#sec-running-tests"><span class="std std-ref">tests</span></a>= aren’t run as part of pre-commit, because they take significant time to complete. Run them manually.</p>
</div>
</section>
</section>
<section id="first-time-contributors">
<span id="sec-first-time-contributors"></span><h2>First Time Contributors<a class="headerlink" href="#first-time-contributors" title="Link to this heading">#</a></h2>
<p>If you’re looking for things to help with, browse our <a class="reference external" href="https://github.com/fandango-fuzzer/fandango/issues">issue tracker</a>!</p>
<p>You do not need to ask for permission to work on any of these issues.
Just fix the issue yourself, <a class="reference internal" href="#sec-running-tests"><span class="std std-ref">try to add a unit test</span></a> and open a pull request.</p>
<p>To get help fixing a specific issue, it’s often best to comment on the issue itself.
You’re much more likely to get help if you provide details about what you’ve tried and where you’ve looked (maintainers tend to help those who help themselves).</p>
</section>
<section id="contributing-code">
<span id="sec-contributing-code"></span><h2>Contributing Code<a class="headerlink" href="#contributing-code" title="Link to this heading">#</a></h2>
<p>Even more excellent than a good bug report is a fix for a bug, or the implementation of a much-needed new feature.
We’d love to have your contributions.</p>
<p>We use the usual GitHub pull-request flow, which may be familiar to you if you’ve contributed to other projects on GitHub.
For the mechanics, see <a class="reference external" href="https://help.github.com/articles/using-pull-requests/">GitHub’s own documentation</a>.</p>
<p>Anyone interested in Fandango may review your code.
One of the Fandango core developers will merge your pull request when they think it’s ready.</p>
<p>If your change will be a significant amount of work to write, we highly recommend starting by opening an issue laying out
what you want to do.
That lets a conversation happen early in case other contributors disagree with what you’d like to do or have ideas that will help you do it.</p>
<p>The best pull requests are focused, clearly describe what they’re for and why they’re correct, and contain tests for whatever changes they make to the code’s behavior.
As a bonus these are easiest for someone to review, which helps your pull request get merged quickly!
Standard advice about good pull requests for open-source projects applies.</p>
<section id="changing-parser-files">
<h3>Changing Parser Files<a class="headerlink" href="#changing-parser-files" title="Link to this heading">#</a></h3>
<p>If your contribution involves changing the ANTLR <code class="docutils literal notranslate"><span class="pre">.g4</span></code> parser files,
you need to <em>regenerate</em> and <em>recompile</em> the parser code.
For this, you need a C++ compiler such as <code class="docutils literal notranslate"><span class="pre">clang</span></code>.</p>
<section id="step-1-generate-the-parser-code">
<h4>Step 1: Generate the parser code<a class="headerlink" href="#step-1-generate-the-parser-code" title="Link to this heading">#</a></h4>
<p>To (re)generate the parser code, use</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>make<span class="w"> </span>parser
</pre></div>
</div>
</section>
<section id="step-2-compile-the-parser-code">
<h4>Step 2: Compile the parser code<a class="headerlink" href="#step-2-compile-the-parser-code" title="Link to this heading">#</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">pip</span></code> command takes care of (re)compiling the parser code.
Simply <a class="reference internal" href="#sec-pip-install"><span class="std std-ref">reinstall Fandango</span></a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If compiling the C++ code for parsing fails,
Fandango uses (slower) Python code instead.</p>
</div>
</section>
</section>
<section id="contributing-to-documentation">
<h3>Contributing to Documentation<a class="headerlink" href="#contributing-to-documentation" title="Link to this heading">#</a></h3>
<p>If you want to contribute to this very tutorial and reference, be sure to preview your changes.
Use</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>make<span class="w"> </span>html
</pre></div>
</div>
<p>to create a HTML version of the documentation in <code class="docutils literal notranslate"><span class="pre">docs/_build/html</span></code>.</p>
</section>
</section>
<section id="attributions">
<h2>Attributions<a class="headerlink" href="#attributions" title="Link to this heading">#</a></h2>
<p>This guide was forked from the <a class="reference external" href="https://github.com/python/mypy/blob/master/CONTRIBUTING.md">mypy contribution guide</a>, which is licensed under the terms of the MIT license.</p>
</section>
</section>

    <script type="text/x-thebe-config">
    {
        requestKernel: true,
        binderOptions: {
            repo: "binder-examples/jupyter-stacks-datascience",
            ref: "master",
        },
        codeMirrorConfig: {
            theme: "abcdef",
            mode: "python"
        },
        kernelOptions: {
            name: "python3",
            path: "./."
        },
        predefinedOutput: true
    }
    </script>
    <script>kernelName = 'python3'</script>

                </article>
              

              
              
              
              
                <footer class="prev-next-footer d-print-none">
                  
<div class="prev-next-area">
    <a class="left-prev"
       href="FAQ.html"
       title="previous page">
      <i class="fa-solid fa-angle-left"></i>
      <div class="prev-next-info">
        <p class="prev-next-subtitle">previous</p>
        <p class="prev-next-title">Fandango FAQ</p>
      </div>
    </a>
    <a class="right-next"
       href="Tutorial.html"
       title="next page">
      <div class="prev-next-info">
        <p class="prev-next-subtitle">next</p>
        <p class="prev-next-title">Fandango Tutorial</p>
      </div>
      <i class="fa-solid fa-angle-right"></i>
    </a>
</div>
                </footer>
              
            </div>
            
            
              
                <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">


  <div class="sidebar-secondary-item">
  <div class="page-toc tocsection onthispage">
    <i class="fa-solid fa-list"></i> Contents
  </div>
  <nav class="bd-toc-nav page-toc">
    <ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#code-of-conduct">Code of Conduct</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#getting-started-with-development">Getting Started with Development</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-1-fork-the-fandango-repository">Step 1: Fork the Fandango repository</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-2-clone-the-fandango-repository-and-enter-into-it">Step 2: Clone the Fandango repository and enter into it</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-3-create-then-activate-a-virtual-environment">Step 3: Create, then activate a virtual environment</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-4-install-development-tools">Step 4: Install development tools</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-5-install-fandango">Step 5: Install Fandango</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#running-tests">Running Tests</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pre-commit">Pre-commit</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#first-time-contributors">First Time Contributors</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#contributing-code">Contributing Code</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#changing-parser-files">Changing Parser Files</a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#step-1-generate-the-parser-code">Step 1: Generate the parser code</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#step-2-compile-the-parser-code">Step 2: Compile the parser code</a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#contributing-to-documentation">Contributing to Documentation</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#attributions">Attributions</a></li>
</ul>
  </nav></div>

</div></div>
              
            
          </div>
          <footer class="bd-footer-content">
            
<div class="bd-footer-content__inner container">
  
  <div class="footer-item">
    
<p class="component-author">
By José Antonio Zamudio Amaya, Marius Smytzek, and Andreas Zeller
</p>

  </div>
  
  <div class="footer-item">
    

  <p class="copyright">
    
      © Copyright 2024-2025 CISPA Helmholtz Center for Information Security (www.cispa.de). All Rights Reserved..
      <br/>
    
  </p>

  </div>
  
  <div class="footer-item">
    
  </div>
  
  <div class="footer-item">
    
  </div>
  
</div>
          </footer>
        

      </main>
    </div>
  </div>
  
  <!-- Scripts loaded after <body> so the DOM is not blocked -->
  <script src="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b"></script>

  <footer class="bd-footer">
  </footer>
  </body>
</html>
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

About

Uh oh!

Languages

fandango-fuzzer/fandango-fuzzer.github.io

Folders and files

Latest commit

History

Repository files navigation

About

Contributing

Uh oh!

Stars

Watchers

Forks

Languages
