docs(guidelines): Add instructions to skip code formatting#12502
Conversation
👋 Hello lucasssvaz, we appreciate your contribution to this project! 📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more. 🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project. Click to see more instructions ...
Review and merge process you can expect ...
|
There was a problem hiding this comment.
Pull request overview
This PR updates the Arduino ESP32 coding guidelines documentation to describe how contributors can selectively disable automatic clang-format formatting in C/C++ source sections when a specific layout must be preserved.
Changes:
- Documented the use of
// clang-format offand// clang-format onmarkers to disable/re-enable formatting. - Added a short C example demonstrating the formatting suppression behavior.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Description of Change
This pull request updates the documentation to clarify how to selectively disable and enable automatic code formatting in C/C++ files using special comments. This helps contributors maintain specific formatting where needed.
Documentation improvements:
// clang-format offand// clang-format oncomments to control code formatting in specific code sections in the coding guidelines (docs/en/guides/coding_guidelines.rst).