Skip to content

Update doc for clang-format and clang-tidy and correct the inconsistency between the document description and the actual formatting behavior#21

Merged
Sunrisepeak merged 6 commits intomainfrom
update-doc
Mar 10, 2026
Merged

Update doc for clang-format and clang-tidy and correct the inconsistency between the document description and the actual formatting behavior#21
Sunrisepeak merged 6 commits intomainfrom
update-doc

Conversation

@FrozenLemonTee
Copy link
Member

No description provided.

Copy link
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 adds standalone documentation pages for the repository’s .clang-format and .clang-tidy configurations, and links them from the main README to make the style/tooling guidance easier to discover.

Changes:

  • Added clang-format.md describing formatting rules with config snippets and examples.
  • Added clang-tidy.md describing the enabled/disabled check sets and recommended usage.
  • Updated README.md to link to the new configuration documentation.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
clang-tidy.md New doc outlining the clang-tidy whitelist strategy, enabled check groups, and examples.
clang-format.md New doc describing clang-format options with examples and a reference section.
README.md Adds a “配置文件” section and links to the new docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Copy link
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

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@FrozenLemonTee FrozenLemonTee changed the title Update doc for clang-format and clang-tidy Update doc for clang-format and clang-tidy and correct the inconsistency between the document description and the actual formatting behavior Mar 10, 2026
@FrozenLemonTee FrozenLemonTee requested a review from Copilot March 10, 2026 03:26
Copy link
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

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

@Sunrisepeak Sunrisepeak merged commit c9ddaf7 into main Mar 10, 2026
4 checks passed
@Sunrisepeak Sunrisepeak deleted the update-doc branch March 10, 2026 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants