<li><strong>Edit files locally or in the GitHub UI</strong>.</li>

<li><strong>Submit a pull request</strong> with your updates.</li>

<p>For help with this workflow, check out this helpful guide:<ahref="https://www.dataschool.io/how-to-contribute-on-github/">Step-by-step guide to contributing on GitHub</a>.</p>

<p>For help with this workflow, check out this helpful guide:<ahref="https://opensource.guide/how-to-contribute/">Step-by-step guide to contributing on GitHub</a>.</p>

<h3id="updating-indexes">Updating Indexes<aclass="headerlink"href="#updating-indexes"title="Permanent link">&para;</a></h3>

<p>When you add new articles or reorganize existing ones, be sure to update the following files:</p>

<li><strong><ahref="https://github.com/cp-algorithms/cp-algorithms/blob/main/src/navigation.md">navigation.md</a></strong>: Update the list of all articles.</li>

<li><strong><ahref="https://github.com/cp-algorithms/cp-algorithms/blob/main/README.md">README.md</a></strong>:Addnew articlesto the mainproject overview.</li>

<li><strong><ahref="https://github.com/cp-algorithms/cp-algorithms/blob/main/README.md">README.md</a></strong>:Update the list ofnew articleson the mainpage.</li>

<h2id="article-syntax">Article Syntax<aclass="headerlink"href="#article-syntax"title="Permanent link">&para;</a></h2>

<p>We use<ahref="https://daringfireball.net/projects/markdown">Markdown</a> to format articles. Articles are rendered using<ahref="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>, which provides a lot of flexibility. Here are some key features:</p>

<spanclass="gu">e_maxx_link: &lt;original-link&gt;</span>

<spanclass="gu">---</span>

<p>Replace<code>&lt;original-link&gt;</code> with theURL tothesource article.</p>

<p>Replace<code>&lt;original-link&gt;</code> with thelast part oftheURL (e.g., for<code>http://e-maxx.ru/algo/euler_function</code>, use<code>euler_function</code>).</p>

<h2id="conventions">Conventions<aclass="headerlink"href="#conventions"title="Permanent link">&para;</a></h2>

<p>Clone the repository:</p>

<divclass="highlight"><pre><span></span><code><spanclass="gp">$</span>git<spanclass="w"></span>clone<spanclass="w"></span>--recursive<spanclass="w"></span>https://github.com/cp-algorithms/cp-algorithms.git<spanclass="w"></span><spanclass="o">&amp;&amp;</span><spanclass="w"></span><spanclass="nb">cd</span><spanclass="w"></span>cp-algorithms

<divclass="highlight"><pre><span></span><code><spanclass="go">gitclone--recursivehttps://github.com/cp-algorithms/cp-algorithms.git&amp;&amp; cd cp-algorithms</span>

<h2id="testing-code-snippets">Testing Code Snippets<aclass="headerlink"href="#testing-code-snippets"title="Permanent link">&para;</a></h2>

<p>If your article includes code snippets, it’s helpful to include tests to ensure that they run correctly.</p>

<p>Name the code snippet:</p>

<divclass="highlight"><pre><span></span><code><spanclass="c1">// code here</span>

<p>Run<code>extract_snippets.py</code> from the<code>test</code> directory to extract snippets into header files. Create a test file that includes these headers and checks their behavior.</p>

<p>You can run all tests with the<code>test.sh</code> script:</p>

<divclass="highlight"><pre><span></span><code><spanclass="gp">$</span><spanclass="nb">cd</span><spanclass="w"></span><spanclass="nb">test</span>

<li>Name the code snippet:

<divclass="highlight"><pre><span></span><code><spanclass="c1">// code here</span>

<li>Run<code>extract_snippets.py</code> from the<code>test</code> directory to extract snippets into header files. Create a test file that includes these headers and checks their behavior.</li>

<li>You can run all tests with the<code>test.sh</code> script:

<divclass="highlight"><pre><span></span><code><spanclass="gp">$</span><spanclass="nb">cd</span><spanclass="w"></span><spanclass="nb">test</span>

<spanclass="gp">$</span>./test.sh

<strong>Example Output:</strong>

<code>Running test_aho_corasick.cpp - Passed in 635 ms

Running test_balanced_brackets.cpp - Passed in 1390 ms

Running test_burnside_tori.cpp - Passed in 378 ms

...

51 PASSED in 49.00 seconds</code>

This script will run tests and display the results.</li>

<p>This script will run tests and display the results.</p>

<p>Additionally, all pull requests will be automatically tested via<ahref="https://github.com/cp-algorithms/cp-algorithms/actions">GitHub Actions</a>.</p>

<ulclass="metadata page-metadata"data-bi-name="page info"lang="en-us"dir="ltr">