This is an automated email from the ASF dual-hosted git repository.
janc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-core.git
The following commit(s) were added to refs/heads/master by this push:
new da33f41d8 docs: add guidance for local style checking with
git-clang-format
da33f41d8 is described below
commit da33f41d83db07c0a4f98d62858fe0e87b2fb6b3
Author: Szymon Czapracki <[email protected]>
AuthorDate: Fri Jun 27 15:46:46 2025 +0200
docs: add guidance for local style checking with git-clang-format
Advise contributors to verify committed changes conform to coding style
before pushing
Include a tip with the exact git-clang-format command to check formatting
against upstream/master
Aimed to reduce CI failures and speed up code reviews by catching issues
early
---
CODING_STANDARDS.md | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/CODING_STANDARDS.md b/CODING_STANDARDS.md
index d5e58c989..1ba3ffa66 100644
--- a/CODING_STANDARDS.md
+++ b/CODING_STANDARDS.md
@@ -39,6 +39,24 @@ source is here: http://www.apache.org/dev/apply-license.html
*/
```
+## Checking coding-style locally
+
+To maintain code quality and consistency across the project, all contributors
+**should** verify that their committed changes conform to the project's coding
style
+before pushing to the remote repository.
+
+We strongly recommend running git-clang-format locally to check your committed
changes.
+This helps catch formatting issues early, avoiding CI failures and reducing
review delays.
+
+> **Tip:** Before pushing your commits, run this command to see any formatting
issues that need fixing:
+>```sh
+>git-clang-format $(git merge-base upstream/master HEAD) HEAD --diff
+>```
+
+**Note**: If clang-format produces incorrect or undesirable results (e.g.,
mangled macros or formatting bugs),
+you may temporarily bypass the formatting check by applying the
skip-style-check label to the pull request.
+Use this only when necessary and explain the reason in the PR description.
+
## Whitespace and Braces
* Code must be indented to 4 spaces, tabs should not be used.
