[Doc][Development] Add tips about how to use lombok

[EricGao888]

Search before asking

• I had searched in the issues and found no similar feature requirement.

Description

• Add some tips in docs about how to use lombok:

1. Use lombok for setters, getters and toString methods in data objects to keep code neat.
2. Avoid using @Data annotation because it will generate some code we may not need, cause the test coverage to decrease and make the Sonar Analysis fail for it.
3. We'd better add a CI check to avoid @Data.

See: https://stackoverflow.com/questions/45569085/sonarqube-bad-coverage-because-of-lombok-data and https://projectlombok.org/features/Data

Documentation Links

No response

Are you willing to submit a PR?

• Yes I am willing to submit a PR!

Code of Conduct

• I agree to follow this project's Code of Conduct

[github-actions]

Thank you for your feedback, we have received your issue, Please wait patiently for a reply.

• In order for us to understand your request as soon as possible, please provide detailed information、version or pictures.
• If you haven't received a reply for a long time, you can join our slack and send your question to channel #troubleshooting

[EricGao888]

Anyone interested in this issue are welcome to comment here to take it. If no one picks it up in 2 weeks, I will take this. Thx : )

[EricGao888]

Here is an example: #11045

[rickchengx]

Hi, @EricGao888 , I'm interested in this issue.

[EricGao888]

We might need some discussions here. Currently there are two potential methods to avoid sonar failing for UT coverage decrease caused by @Data:

1. Use the method described in this issue.
2. Keep @Data and fix sonar instead to exclude code generated by lombok

See: #11133 (comment)

related: #11133

[EricGao888]

We might need some discussions here. Currently there are two potential methods to avoid sonar failing for UT coverage decrease caused by @Data:

1. Use the method described in this issue.
2. Keep @Data and fix sonar instead to exclude code generated by lombok

See: #11133 (comment)

related: #11133

I don't have strong opinions here about which method to take, as long as we stick to one of them to keep consistency. If we agree on taking the second one, we need to fix sonar in this issue instead of adding docs and changing CI. WDYT @SbloodyS @kezhenxu94 @rickchengx

[SbloodyS]

I think the second option is more friendly for contributors. So it's better to me.