OpenSoure_Repos/TheAlgorithms-C-Plus-Plus
1
0
Fork 0
mirror of https://hub.njuu.cf/TheAlgorithms/C-Plus-Plus.git synced 2023-10-11 13:05:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: minor Markdown improvements

Browse Source
This commit is contained in:
David Leal 2022-09-29 14:26:13 -05:00 committed by GitHub
parent 1772ee06cc
commit c1f17927aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -37,7 +37,7 @@ You can add new algorithms or data structures that are **not present in the repo
- You can suggest reasonable changes to existing algorithms. - You can suggest reasonable changes to existing algorithms.
- Strictly use snake_case (underscore_separated) in filenames. - Strictly use snake_case (underscore_separated) in filenames.
- If you have added or modified code, please make sure the code compiles before submitting. - If you have added or modified code, please make sure the code compiles before submitting.
- Our automated testing runs [__CMake__](https://cmake.org/) on all the pull requests, so please be sure that your code passes before submitting. - Our automated testing runs [**CMake**](https://cmake.org/) on all the pull requests, so please be sure that your code passes before submitting.
- Please conform to [Doxygen](https://www.doxygen.nl/manual/docblocks.html) standards and document the code as much as possible. This not only facilitates the readers but also generates the correct info on the website. - Please conform to [Doxygen](https://www.doxygen.nl/manual/docblocks.html) standards and document the code as much as possible. This not only facilitates the readers but also generates the correct info on the website.
- **Be consistent in the use of these guidelines.** - **Be consistent in the use of these guidelines.**
@ -212,7 +212,7 @@ clang-tidy --fix --quiet -p build subfolder/file_to_check.cpp --
#### Code Formatter #### Code Formatter
[`__clang-format__`](https://clang.llvm.org/docs/ClangFormat.html) is used for code formatting. [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html) is used for code formatting.
- Installation (only needs to be installed once.) - Installation (only needs to be installed once.)
- Mac (using home-brew): `brew install clang-format` - Mac (using home-brew): `brew install clang-format`