Skip to content

Commit

Permalink
Deployed 95312b8 to main with MkDocs 1.4.3 and mike 2.1.0.dev0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Nov 16, 2023
1 parent 94697c4 commit c997b5e
Show file tree
Hide file tree
Showing 4 changed files with 256 additions and 251 deletions.
11 changes: 8 additions & 3 deletions main/contributing/pull-request-guidelines/ci-checks/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5827,9 +5827,14 @@ <h2 id="pre-commit">pre-commit<a class="headerlink" href="#pre-commit" title="Pe
<div class="highlight"><pre><span></span><code>pre-commit<span class="w"> </span>run<span class="w"> </span>-a<span class="w"> </span>--config<span class="w"> </span>.pre-commit-config-optional.yaml
</code></pre></div>
<h2 id="spell-check-differential">spell-check-differential<a class="headerlink" href="#spell-check-differential" title="Permanent link">#</a></h2>
<p>This workflow detects spelling mistakes using <a href="https://github.com/streetsidesoftware/cspell">CSpell</a> with <a href="https://github.com/tier4/autoware-spell-check-dict/blob/main/.cspell.json">our dictionary file</a>.<br>
You can submit pull requests to <a href="https://github.com/tier4/autoware-spell-check-dict">tier4/autoware-spell-check-dict</a> to update the dictionary.</p>
<p>Since it is difficult to detect errors with no false positives, it is an optional workflow, but it is preferable to remove spelling mistakes as many as possible.</p>
<p>This workflow detects spelling mistakes using <a href="https://github.com/streetsidesoftware/cspell">CSpell</a> with <a href="https://github.com/tier4/autoware-spell-check-dict/blob/main/.cspell.json">our dictionary file</a>.
Since it is difficult to detect errors with no false positives, it is an optional workflow, but it is preferable to remove spelling mistakes as many as possible.</p>
<p>You have the following options if you need to use a word that is not registered in the dictionary.</p>
<ul>
<li>If the word is only used in a few files, you can use <a href="https://cspell.org/configuration/document-settings/">inline document settings "cspell:ignore"</a> to suppress the check.</li>
<li>If the word is widely used in the repository, you can create a local cspell json and pass it to the <a href="https://github.com/autowarefoundation/autoware-github-actions/tree/main/spell-check">spell-check action</a>.</li>
<li>If the word is common and may be used in many repositories, you can submit pull requests to <a href="https://github.com/tier4/autoware-spell-check-dict">tier4/autoware-spell-check-dict</a> or <a href="https://github.com/tier4/cspell-dicts">tier4/cspell-dicts</a> to update the dictionary.</li>
</ul>
<h2 id="build-and-test-differential">build-and-test-differential<a class="headerlink" href="#build-and-test-differential" title="Permanent link">#</a></h2>
<p>This workflow checks <code>colcon build</code> and <code>colcon test</code> for the pull request.<br>
To make the CI faster, it doesn't check all packages but only modified packages and the dependencies.</p>
Expand Down
2 changes: 1 addition & 1 deletion main/search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit c997b5e

Please sign in to comment.