diff --git a/d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html b/d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html index b9f45471..c24d7721 100644 --- a/d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html +++ b/d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html @@ -102,7 +102,7 @@ $(document).ready(function(){initNavTree('d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.htm

Before contributing

-

Welcome to TheAlgorithms/C! Before submitting pull requests, please make sure that you have read the whole guidelines. If you have any doubts about this contribution guide, please open an issue or ask in our Discord server, and clearly state your concerns.

+

Welcome to TheAlgorithms/C! Before submitting pull requests, please make sure that you have read the whole guidelines. If you have any doubts about this contribution guide, please open an issue or ask on our Discord server, and clearly state your concerns.

Contributing

@@ -113,14 +113,14 @@ Contributor

Being a contributor at The Algorithms, we request you to follow the points mentioned below:

New implementation New implementations are welcome!

-

You can add new algorithms or data structures which are not present in the repository or that can improve the old implementations (documentation, improving test cases, removing bugs or in any other resonable sense)

+

You can add new algorithms or data structures that are not present in the repository or that can improve the old implementations (documentation, improving test cases, removing bugs, or in any other reasonable sense)

Issues Please avoid opening issues asking to be "assigned” to a particular algorithm. This merely creates unnecessary noise for maintainers. Instead, please submit your implementation in a pull request, and it will be evaluated by project maintainers. @subsection autotoc_md22 Making Changes @@ -135,7 +135,7 @@ Contributor - Strictly use snake_case (underscore_separated) in filenames. - If you have added or modified code, please make sure the code compiles before submitting. - Our automated testing runs <a href="https://cmake.org/" target="_blank" ><strong>CMake</strong></a> on all the pull requests, so please be sure that your code passes before submitting. -- Please conform to <a href="https://www.doxygen.nl/manual/docblocks.html" target="_blank" >Doxygen</a> standard and document the code as much as possible. This not only facilitates the readers but also generates the correct info on website. +- Please conform to <a href="https://www.doxygen.nl/manual/docblocks.html" target="_blank" >Doxygen</a> standards and document the code as much as possible. This not only facilitates the readers but also generates the correct info on the website. - <strong>Be consistent in the use of these guidelines.</strong> @subsubsection autotoc_md24 Documentation @@ -157,7 +157,8 @@ Contributor @icode{c} /** * @file - * @brief Add one line description here + * @brief Add one line description here. Should contain a Wikipedia + * link or another source explaining the algorithm/implementation. * @details * This is a multi-line * description containing links, references, @@ -227,7 +228,7 @@ my_new_c_struct.c is correct format - It will be used to dynamically create a directory of files and implementation. - File name validation will run on Docker to ensure validity. -- 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 <tt>median_search.c</tt> already exists in the <tt>search</tt> folder, and you are contributing a new implementation, the filename should be <tt>median_search2.c</tt> and for a third implementation, <tt>median_search3.c</tt>. +- If an implementation of the algorithm already exists and your version is different from that implemented, please use an incremental numeric digit as a suffix. For example: if <tt>median_search.c</tt> already exists in the <tt>search</tt> folder, and you are contributing a new implementation, the filename should be <tt>median_search2.c</tt>. For a third implementation, <tt>median_search3.c</tt>, and so on. @subsubsection autotoc_md28 Directory guidelines @@ -259,6 +260,7 @@ fix: xyz algorithm bug feat: add xyx algorithm, struct xyz test: add test for xyz algorithm docs: add comments and explanation to xyz algorithm +chore: update Gitpod badge @endicode Common prefixes: @@ -267,6 +269,7 @@ Common prefixes: - feat: A new feature - docs: Documentation changes - test: Correct existing tests or add new ones +- chore: Miscellaneous changes that do not match any of the above. @subsection autotoc_md30 Pull Requests @@ -282,7 +285,7 @@ cmake -B build -S . @subsubsection autotoc_md32 Static Code Analyzer -We use <a href="https://clang.llvm.org/extra/clang-tidy/" target="_blank" >clang-tidy</a> as a static code analyzer with a configuration in <a href=".clang-tidy" target="_blank" >.clang-tidy</a>. +We use <a href="https://clang.llvm.org/extra/clang-tidy/" target="_blank" ><tt>clang-tidy</tt></a> as a static code analyzer with a configuration in <a href=".clang-tidy" target="_blank" ><tt>.clang-tidy</tt></a>. @icode{bash} clang-tidy --fix --quiet -p build subfolder/file_to_check.c -- @@ -290,7 +293,7 @@ clang-tidy --fix --quiet -p build subfolder/file_to_check.c -- @subsubsection autotoc_md33 Code Formatter -<a href="https://clang.llvm.org/docs/ClangFormat.html" target="_blank" ><strong>clang-format</strong></a> is used for code forrmating. +<a href="https://clang.llvm.org/docs/ClangFormat.html" target="_blank" >**<tt>clang-format</tt>**</a> is used for code formatting. - Installation (only needs to be installed once.) - Mac (using home-brew): <tt>brew install clang-format</tt> @@ -302,7 +305,7 @@ clang-tidy --fix --quiet -p build subfolder/file_to_check.c -- @subsubsection autotoc_md34 GitHub Actions - Enable GitHub Actions on your fork of the repository. -After enabling, it will execute <tt>clang-tidy</tt> and <tt>clang-format</tt> after every a push (not a commit). +After enabling, it will execute <tt>clang-tidy</tt> and <tt>clang-format</tt> after every push (not a commit). - Click on the tab "Actions", then click on the big green button to enable it. <img src="https://user-images.githubusercontent.com/51391473/94609466-6e925100-0264-11eb-9d6f-3706190eab2b.png" alt="GitHub Actions"/>