Documentation for de868c9faa

This commit is contained in:
github-actions
2020-08-25 23:26:01 +00:00
parent 1188879ca7
commit 9e1217846f
9 changed files with 51 additions and 47 deletions

View File

@@ -120,7 +120,8 @@ Code</h3>
<li>Please use the directory structure of the repository.</li>
<li>File extension for code should be *.h *.cpp.</li>
<li>Don't use <b>bits/stdc++.h</b> because this is quite Linux specific and slows down the compilation process.</li>
<li>Avoid using <b>struct</b> and instead use the <b>class</b> keyword.</li>
<li>Organize your code using **<code>struct</code>**, **<code>class</code>** and/or **<code>namespace</code>** keywords</li>
<li>If an implementation of the algorithm already exists, please refer to the <a href="../../#new-file-name-guidelines">file-name section below</a>.</li>
<li>You can suggest reasonable changes to existing algorithms.</li>
<li>Strictly use snake_case (underscore_separated) in filenames.</li>
<li>If you have added or modified code, please make sure the code compiles before submitting.</li>
@@ -215,6 +216,7 @@ New File Name guidelines</h3>
</div><!-- fragment --></li>
<li>It will be used to dynamically create a directory of files and implementation.</li>
<li>File name validation will run on docker to ensure the validity.</li>
<li>If an implementation of the algorithm already exists and your version is different from that implemented, please use incremental numeric digit as a suffix. For example, if <code><a class="el" href="../../d9/d69/median__search_8cpp.html" title="Implementation of Median search algorithm. @cases from here">median_search.cpp</a></code> already exists in the <code>search</code> folder and you are contributing a new implementation, the filename should be <code>median_search2.cpp</code> and for a third implementation, <code>median_search3.cpp</code>.</li>
</ul>
<h3><a class="anchor" id="autotoc_md13"></a>
New Directory guidelines</h3>