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

Improve copyright checker #855

Closed
hzxuzhonghu opened this issue Sep 14, 2024 · 12 comments
Closed

Improve copyright checker #855

hzxuzhonghu opened this issue Sep 14, 2024 · 12 comments
Assignees
Labels
good first issue Good for newcomers

Comments

@hzxuzhonghu
Copy link
Member

Task description:

We can add a copyright checker to prevent creating files without copyright https://github.com/kmesh-net/kmesh/blob/main/pkg/utils/exec.go#L1-L14

And for .c .h files, https://github.com/kmesh-net/kmesh/blob/main/bpf/deserialization_to_bpf_map/deserialization_to_bpf_map.c#L2

Solution:

Who can join or take the task:

The good first issue is intended for first-time contributors to get started on his/her contributor journey.

After a contributor has successfully completed 1-2 good first issue's,
they should be ready to move on to help wanted items, saving the remaining good first issue for other new contributors.

How to join or take the task:

Just reply on the issue with the message /assign in a separate line.

Then, the issue will be assigned to you.

How to ask for help:

If you need help or have questions, please feel free to ask on this issue.
The issue author or other members of the community will guide you through the contribution process.

@hzxuzhonghu hzxuzhonghu added the good first issue Good for newcomers label Sep 14, 2024
@yuluo-yx
Copy link
Contributor

/assign @yuluo-yx

@yuluo-yx
Copy link
Contributor

yuluo-yx commented Sep 15, 2024

@hzxuzhonghu
Copy link
Member Author

Yeah. But i kind of remember it did not fail this pr #853 (comment)

@yuluo-yx
Copy link
Contributor

yuluo-yx commented Sep 18, 2024

Yeah. But i kind of remember it did not fail this pr #853 (comment)

This script may not be easy to use, I can refactor it using skywalking-eyes.

@hzxuzhonghu
Copy link
Member Author

IIRC hack/copyright-check.sh is missing some dir check

@hzxuzhonghu hzxuzhonghu changed the title Add copyright checker Improve copyright checker Sep 29, 2024
@hzxuzhonghu
Copy link
Member Author

cc @yuluo-yx

@yuluo-yx
Copy link
Contributor

cc @yuluo-yx

get, I will try to update.

@yuluo-yx
Copy link
Contributor

@hzxuzhonghu I deleted /pkg/controller/workloader/common.go locally and the shell script is fine, it works fine

image

image

maybe we don’t need to update?

@hzxuzhonghu
Copy link
Member Author

go_dirs="$ROOT_DIR/pkg"
c_dirs="$ROOT_DIR/bpf"

From the script, we can see it only checks these two dirs. That;s not enough, we have many other packages

@yuluo-yx
Copy link
Contributor

yuluo-yx commented Oct 8, 2024

@hzxuzhonghu I've finished this issue, you can close it.

I am very interested in cloud native and traffic management. If you have other good questions or simple tasks, you can assign them to me and I will try to do them. Thank you very much 🤔

@LiZhenCheng9527
Copy link
Collaborator

LiZhenCheng9527 commented Oct 8, 2024

Thank you
/close

@kmesh-bot
Copy link
Collaborator

@LiZhenCheng9527: Closing this issue.

In response to this:

Done
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants