Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Doc] Fix code-style-guides' titles for protobuf and thrift. #56324

Merged
merged 1 commit into from
Feb 27, 2025
Merged

[Doc] Fix code-style-guides' titles for protobuf and thrift. #56324

merged 1 commit into from
Feb 27, 2025

Conversation

kritchie
Copy link
Contributor

Why I'm doing:

The table-of-content for code-style-guides is not really helpful in its current form:

image

What I'm doing:

Renamed the titles of the files to be more explicit (keeping the same naming as the .md files) :

  1. Rules -> Protobuf Guides
  2. Rules -> Thrift Guides

Fixes #56323

What type of PR is this:

  • BugFix
  • Feature
  • Enhancement
  • Refactor
  • UT
  • Doc
  • Tool

Does this PR entail a change in behavior?

  • Yes, this PR will result in a change in behavior.
  • No, this PR will not result in a change in behavior.

If yes, please specify the type of change:

  • Interface/UI changes: syntax, type conversion, expression evaluation, display information
  • Parameter changes: default values, similar parameters but with different default values
  • Policy changes: use new policy to replace old one, functionality automatically enabled
  • Feature removed
  • Miscellaneous: upgrade & downgrade compatibility, etc.

Checklist:

  • I have added test cases for my bug fix or my new feature
  • This pr needs user documentation (for new or modified features or behaviors)
    • I have added documentation for my new feature or new function
  • This is a backport pr

Bugfix cherry-pick branch check:

  • I have checked the version labels which the pr will be auto-backported to the target branch
    • 3.4
    • 3.3
    • 3.2
    • 3.1
    • 3.0

@kritchie kritchie changed the title [Doc] Fix code-style-guides' titles for protobuf and thrift. (#56323) [Doc] Fix code-style-guides' titles for protobuf and thrift. Feb 26, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation 3.2 3.1 3.3 3.4 labels Feb 26, 2025
DanRoscigno
DanRoscigno approved these changes Feb 27, 2025
View reviewed changes
Copy link
Contributor

@DanRoscigno DanRoscigno left a comment

Choose a reason for hiding this comment

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

Thanks very much @kritchie

@github-actions GitHub Actions
Copy link

[Java-Extensions Incremental Coverage Report]

✅ pass : 0 / 0 (0%)

@github-actions GitHub Actions
Copy link

[FE Incremental Coverage Report]

✅ pass : 0 / 0 (0%)

@github-actions GitHub Actions
Copy link

[BE Incremental Coverage Report]

✅ pass : 0 / 0 (0%)

@andyziye andyziye merged commit 32163a2 into StarRocks:main Feb 27, 2025
59 checks passed
@github-actions GitHub Actions
Copy link

@Mergifyio backport branch-3.1

@github-actions GitHub Actions
Copy link

@Mergifyio backport branch-3.3

@github-actions github-actions bot removed the 3.1 label Feb 27, 2025
@github-actions GitHub Actions
Copy link

@Mergifyio backport branch-3.4

@github-actions GitHub Actions
Copy link

@Mergifyio backport branch-3.2

@mergify Mergify
Copy link
Contributor

mergify bot commented Feb 27, 2025 •
edited
Loading

backport branch-3.1

✅ Backports have been created

@mergify Mergify
Copy link
Contributor

mergify bot commented Feb 27, 2025 •
edited
Loading

backport branch-3.3

✅ Backports have been created

@mergify Mergify
Copy link
Contributor

mergify bot commented Feb 27, 2025 •
edited
Loading

backport branch-3.4

✅ Backports have been created

@mergify Mergify
Copy link
Contributor

mergify bot commented Feb 27, 2025 •
edited
Loading

backport branch-3.2

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Feb 27, 2025
@kritchie @mergify
[Doc] Fix code-style-guides' titles for protobuf and thrift. (#56324)
361c1c9 
Signed-off-by: kritchie <[email protected]>
(cherry picked from commit 32163a2)
@mergify mergify bot mentioned this pull request Feb 27, 2025
Merged
18 tasks
mergify bot pushed a commit that referenced this pull request Feb 27, 2025
@kritchie @mergify
[Doc] Fix code-style-guides' titles for protobuf and thrift. (#56324)
119f6de 
Signed-off-by: kritchie <[email protected]>
(cherry picked from commit 32163a2)
mergify bot pushed a commit that referenced this pull request Feb 27, 2025
@kritchie @mergify
[Doc] Fix code-style-guides' titles for protobuf and thrift. (#56324)
a74437d 
Signed-off-by: kritchie <[email protected]>
(cherry picked from commit 32163a2)
This was referenced Feb 27, 2025
Merged
Merged
mergify bot pushed a commit that referenced this pull request Feb 27, 2025
@kritchie @mergify
[Doc] Fix code-style-guides' titles for protobuf and thrift. (#56324)
79e041e 
Signed-off-by: kritchie <[email protected]>
(cherry picked from commit 32163a2)
@mergify mergify bot mentioned this pull request Feb 27, 2025
Merged
18 tasks
wanpengfei-git pushed a commit that referenced this pull request Feb 27, 2025
@mergify @kritchie
[Doc] Fix code-style-guides' titles for protobuf and thrift. (backport …
0f215fd 
…#56324) (#56383)

Co-authored-by: kritchie <[email protected]>
wanpengfei-git pushed a commit that referenced this pull request Feb 27, 2025
@mergify @kritchie
[Doc] Fix code-style-guides' titles for protobuf and thrift. (backport …
e0e2342 
…#56324) (#56382)

Co-authored-by: kritchie <[email protected]>
wanpengfei-git pushed a commit that referenced this pull request Feb 27, 2025
@mergify @kritchie
[Doc] Fix code-style-guides' titles for protobuf and thrift. (backport …
b8d1119 
…#56324) (#56381)

Co-authored-by: kritchie <[email protected]>
wanpengfei-git pushed a commit that referenced this pull request Feb 27, 2025
@mergify @kritchie
[Doc] Fix code-style-guides' titles for protobuf and thrift. (backport …
f5fd581 
…#56324) (#56380)

Co-authored-by: kritchie <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DanRoscigno DanRoscigno DanRoscigno approved these changes

@yongbingwang yongbingwang yongbingwang approved these changes

Assignees

@kritchie kritchie

Labels
3.1-merged 3.2-merged 3.3-merged 3.4-merged documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

English developers' documentation code style guides appear to misnamed.
4 participants
@kritchie @DanRoscigno @yongbingwang @andyziye