We are very happy that you consider implementing algorithms and data structures for others! This repository is referred to and used by learners from around the globe. Being one of our contributors, you agree and confirm that:
+- You did your own work.
- No plagiarism allowed. Any plagiarized work will not be merged.
- Please use the directory structure of the repository. -
- File extension for code should be *.h *.cpp. +
- File extension for code should be
*.hpp,*.hor*.cpp. - Don't use bits/stdc++.h because this is quite Linux specific and slows down the compilation process.
- Organize your code using **
struct**, **class** and/or **namespace** keywords - If an implementation of the algorithm already exists, please refer to the file-name section below.
- You can suggest reasonable changes to existing algorithms.
- 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 cpplint on all pull requests so please be sure that your code passes before submitting. +
- Our automated testing runs CMake on all pull requests so please be sure that your code passes before submitting.
- Please conform to doxygen standard and document the code as much as possible. This not only facilitates the readers but also generates the correct info on website.
- Be consistent in use of these guidelines.
- Make sure you put useful comments in your code. Do not comment things that are obvious.
- Please avoid creating new directories if at all possible. Try to fit your work into the existing directory structure. If you want to create a new directory, then please check if a similar category has been recently suggested or created by other pull requests.
- If you have modified/added documentation, please ensure that your language is concise and contains no grammar errors. -
- Do not update README.md along with other changes, first create an issue and then link to that issue in your pull request to suggest specific changes required to README.md -
- The repository follows Doxygen standards and auto-generates the repo website. Please ensure the code is documented in this structure. Sample implementation is given below. +
- Do not update
README.mdalong with other changes. First create an issue and then link to that issue in your pull request to suggest specific changes required toREADME.md.
+ - The repository follows Doxygen standards and auto-generates the repository website. Please ensure the code is documented in this structure. Sample implementation is given below.
Test
- Make sure to add examples and test cases in your main() function.
- If you find any algorithm or document without tests, please feel free to create a pull request or issue describing suggested changes. -
- Please try to add one or more
test()functions that will invoke the algorithm implementation on random test data with expected output. Useassert()function to confirm that the tests will pass.
+ - Please try to add one or more
test()functions that will invoke the algorithm implementation on random test data with expected output. Useassert()function to confirm that the tests will pass. Requires including thecassertheader.
-Typical structure of a program:
+Typical structure of a program/**
- * @file
+ * @file
* @brief Add one line description here
- * @details
+ * @details
* This is a multi line
* description containing links, references,
* math equations, etc
@@ -158,7 +159,8 @@ Typical structure of a program:
* @see related_file.cpp, another_file.cpp
*/
#include
+#include <cassert>
+#include
/**
* @namespace <check from other files in this repo>
@@ -194,8 +196,12 @@ Typical structure of a program:
return true;
}
+} // namespace name
/** Test function */
+/**
+ * @brief Test implementations
+ * @returns void
+ */
/* desciptions of the following test */
assert(func(...) == ...); // this ensures that the algorithm works as expected
@@ -203,7 +209,12 @@ Typical structure of a program:
// can have multiple checks
}
/** Main function */
+/**
+ * @brief Main function
+ * @param argc commandline argument count (ignored)
+ * @param argv commandline array of arguments (ignored)
+ * @returns 0 on exit
+ */
test(); // execute the tests
// code here
@@ -213,9 +224,11 @@ Typical structure of a program:
New File Name guidelines
- Use lowercase words with
"_"as separator
- - For instance MyNewCppClass.CPP is incorrect+
- For instance
+ ++MyNewCppClass.CPP is incorrectmy_new_cpp_class.cpp 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 the 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
median_search.cppalready exists in thesearchfolder and you are contributing a new implementation, the filename should bemedian_search2.cppand for a third implementation,median_search3.cpp.
@@ -225,24 +238,28 @@ New Directory guidelines
- We recommend adding files to existing directories as much as possible.
- Use lowercase words with
"_"as separator ( no spaces or"-"allowed )
- - For instance SomeNew Fancy-Category is incorrect+
- For instance
+ ++SomeNew Fancy-Category is incorrectsome_new_fancy_category is correct-- Filepaths will be used to dynamically create a directory of our algorithms.
- Filepath validation will run on GitHub Actions to ensure compliance.
Commit Guidelines
-
-
- It is recommended to keep your changes grouped logically within individual commits. Maintainers find it easier to understand changes that are logically spilt across multiple commits. Try to modify just one or two files in the same directory. Pull requests that span multiple directories are often rejected. git add file_xyz.cpp-git commit -m "your message"-
+
- It is recommended to keep your changes grouped logically within individual commits. Maintainers find it easier to understand changes that are logically spilt across multiple commits. Try to modify just one or two files in the same directory. Pull requests that span multiple directories are often rejected.
Examples of commit messages with semantic prefixes:
fix: xyz algorithm bug+git add file_xyz.cpp+git commit -m "your message"+Examples of commit messages with semantic prefixes:
+fix: xyz algorithm bugfeat: add xyx algorithm, class xyztest: add test for xyz algorithmdocs: add comments and explanation to xyz algorithm-Common prefixes:
-
+
Common prefixes:
+- fix: A bug fix
- feat: A new feature
- docs: Documentation changes @@ -255,14 +272,17 @@ Pull Requests
Building Locally
-Before submitting a pull request, build the code locally or using the convenient
service.
diff --git a/navtreedata.js b/navtreedata.js index d09901433..1a2e828ce 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -47,7 +47,7 @@ var NAVTREE = [ "Code", "d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html#autotoc_md15", null ], [ "Documentation", "d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html#autotoc_md16", null ], [ "Test", "d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html#autotoc_md17", null ], - [ "Typical structure of a program:", "d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html#autotoc_md18", null ], + [ "Typical structure of a program", "d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html#autotoc_md18", null ], [ "New File Name guidelines", "d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html#autotoc_md19", null ], [ "New Directory guidelines", "d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html#autotoc_md20", null ], [ "Commit Guidelines", "d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html#autotoc_md21", null ]cmake -B build -S .+Before submitting a pull request, build the code locally or using the convenient
+cmake -B build -S .Static Code Analyzer
-We use clang-tidy as a static code analyzer with a configuration in .clang-tidy.
clang-tidy --fix --quiet -p build subfolder/file_to_check.cpp --+We use clang-tidy as a static code analyzer with a configuration in .clang-tidy.
+clang-tidy --fix --quiet -p build subfolder/file_to_check.cpp --Code Formatter
-clang-format is used for code forrmating.
-
-
- Installation (Only needs to be installed once.)
-
+
- Installation (only needs to be installed once.)
- Mac (using home-brew):
brew install clang-format - Mac (using macports):
sudo port install clang-10 +analyzer - Windows (MSYS2 64-bit):
pacman -S mingw-w64-x86_64-clang-tools-extra
@@ -273,8 +293,20 @@ Code Formatter
GitHub Actions
-Enable GitHub Actions on your fork of the repository. After enabling it will execute
-clang-tidyandclang-formatafter every a push (not a commit). The result can create another commit if the actions made any changes on your behalf. Hence, it is better to wait and check the results of GitHub Actions after every push. Rungit pullin your local clone if these actions made many changes in order to avoid merge conflicts.Most importantly,
-
+
- Enable GitHub Actions on your fork of the repository. After enabling it will execute
clang-tidyandclang-formatafter every push (not a commit).-
+
- Click on the tab "Actions", then click on the big green button to enable it. +
+ - The result can create another commit if the actions made any changes on your behalf. +
- Hence, it is better to wait and check the results of GitHub Actions after every push. +
- Run
git pullin your local clone if these actions made many changes in order to avoid merge conflicts.
+ - Happy coding!
-
+
+
-
+
Most importantly,
+ - Mac (using home-brew):
clang-format is used for code forrmating.
+-
+
- Installation (only needs to be installed once.)