diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f5b0865..437d272 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ So, before you jump right into your code editor and start working on your projec - Also, your c/c++ code will be linted automatically as soon as you make the PR. The PR will be merged if and only if all the checks are completed. If there's any issue with the linting of your work, you can contact the maintainer within the conversation tab of your PR. -- The linter used in the repo is [C/C++ Linter](https://github.com/marketplace/actions/c-c-linter "view in marketplace"), this linter is using [clang-tidy](https://clang.llvm.org/extra/clang-tidy/ "visit official website") and [clang-format](https://clang.llvm.org/docs/ClangFormatStyleOptions.html "visit official website") for stict checking of code-writing standards *(which mean they also check for the way you write your code)*. Even though your code successfully complies and runs as expected, if it's not following the coding standards or clang rules then the checks fails. +- The linter used in the repo is [C/C++ Linter](https://github.com/marketplace/actions/c-c-linter "view in marketplace"), this linter is using [clang-tidy](https://clang.llvm.org/extra/clang-tidy/ "visit official website") and [clang-format](https://clang.llvm.org/docs/ClangFormatStyleOptions.html "visit official website") for strict checking of code-writing standards *(which mean they also check for the way you write your code)*. Even though your code successfully complies and runs as expected, if it's not following the coding standards or clang rules then the checks fails. - If you facing an issue while fixing your code to follow the coding standards then make sure to check the linting workflow as the step `Show diffs and exit` within the liniting workflow displays output of the command `clang-format-12 -style=Google ` *(which basically shows the formatted version of your code by following the stye guide provided by Google)*. @@ -168,4 +168,4 @@ Here are some ground rules that you need to follow: - Sending several pull requests for a single post is not accepted. - Your Pull Request will not be merged, if you have modified, changed or deleted any files or content that doesn't belong to you. - Pull Request containing any illegal, NFSW or any other content which doesn't help others in any way possible will be closed immediately. -- The Pull Request will only be merged if everything seems to be in order. You be notified if you did something wrong, and your pull request will only be merged if the notified changes are made. \ No newline at end of file +- The Pull Request will only be merged if everything seems to be in order. You be notified if you did something wrong, and your pull request will only be merged if the notified changes are made.