Skip to content

docs(guidelines): Add instructions to skip code formatting#12502

Merged
me-no-dev merged 1 commit into
espressif:masterfrom
lucasssvaz:docs/format_except
Apr 8, 2026
Merged

docs(guidelines): Add instructions to skip code formatting#12502
me-no-dev merged 1 commit into
espressif:masterfrom
lucasssvaz:docs/format_except

Conversation

@lucasssvaz
Copy link
Copy Markdown
Member

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:

  • Added instructions and an example for using // clang-format off and // clang-format on comments to control code formatting in specific code sections in the coding guidelines (docs/en/guides/coding_guidelines.rst).

@lucasssvaz lucasssvaz self-assigned this Apr 6, 2026
@lucasssvaz lucasssvaz requested a review from pedrominatel as a code owner April 6, 2026 15:58
Copilot AI review requested due to automatic review settings April 6, 2026 15:58
@lucasssvaz lucasssvaz added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Apr 6, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 6, 2026

Messages
📖 🎉 Good Job! All checks are passing!

👋 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 ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 1d464ca

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 off and // clang-format on markers 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.

@P-R-O-C-H-Y P-R-O-C-H-Y added the Status: Pending Merge Pull Request is ready to be merged label Apr 8, 2026
@me-no-dev me-no-dev merged commit ca04a02 into espressif:master Apr 8, 2026
22 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Status: Pending Merge Pull Request is ready to be merged Type: Documentation Issue pertains to Documentation of Arduino ESP32

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants