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.

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

Add comment for clusters and UI display #5072

Merged
merged 4 commits into from
Jan 13, 2024

Conversation

BlackBear2003
Copy link
Contributor

@BlackBear2003 BlackBear2003 commented Jan 8, 2024

What's the purpose of this PR

Add comment for clusters and UI display

Which issue(s) this PR fixes:

Fixes ##5067

Brief changelog

it looks like:

WX20240108-215908@2x
image

Follow this checklist to help us incorporate your contribution quickly and easily:

  • Read the Contributing Guide before making this pull request.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Write necessary unit tests to verify the code.
  • Run mvn clean test to make sure this pull request doesn't break anything.
  • Update the CHANGES log.

@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Jan 8, 2024
Copy link

codecov bot commented Jan 8, 2024

Codecov Report

Attention: 7 lines in your changes are missing coverage. Please review.

Comparison is base (6657a58) 49.65% compared to head (8db44fa) 49.60%.

Files Patch % Lines
...com/ctrip/framework/apollo/biz/entity/Cluster.java 0.00% 4 Missing ⚠️
.../ctrip/framework/apollo/common/dto/ClusterDTO.java 0.00% 3 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##             master    #5072      +/-   ##
============================================
- Coverage     49.65%   49.60%   -0.06%     
+ Complexity     1905     1904       -1     
============================================
  Files           372      372              
  Lines         11558    11564       +6     
  Branches       1127     1127              
============================================
- Hits           5739     5736       -3     
- Misses         5478     5488      +10     
+ Partials        341      340       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nobodyiam
Copy link
Member

This looks great! Please find some comments below:

  1. I think the comment is similar to the remarks of namespace, so it's better to use the same term, e.g. Remarks and 备注
    image
    image

  2. I think the comment should not be mandatory, as it's not a necessary information

  3. When displaying the comment, it's not necessary to display the prefix comment:

@BlackBear2003
Copy link
Contributor Author

I think the comment is similar to the remarks of namespace, so it's better to use the same term, e.g. Remarks and 备注

changed terms at front-end from 'comment' to 'remarks'.

I'm not sure should we change the sql and entity's field name? I see there is comment in AppNamespace, Commit and Item while there is not remarks. So I just use remark when UI display.

image image

Copy link
Member

@nobodyiam nobodyiam left a comment

Choose a reason for hiding this comment

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

This looks fantastic! Below are a few comments for your consideration. Additionally, please update the CHANGES.md file to inform users about this new feature.

Copy link
Member

@nobodyiam nobodyiam left a comment

Choose a reason for hiding this comment

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

LGTM

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 13, 2024
@nobodyiam nobodyiam merged commit 63a68f5 into apolloconfig:master Jan 13, 2024
10 of 12 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jan 13, 2024
@nobodyiam nobodyiam added this to the 2.3.0 milestone Apr 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm This PR has been approved by a maintainer size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants