diff --git a/Contributing.md b/Contributing.md index f17eb24..4e7920a 100644 --- a/Contributing.md +++ b/Contributing.md @@ -25,6 +25,14 @@ Please follow [best practices](https://github.com/trein/dev-best-practices/wiki/ When your code is ready to be submitted, you can [submit a pull request](https://help.github.com/articles/creating-a-pull-request/) to begin the code review process. +#### Add license + +Please use license headers in all code files. You can apply the `./license_header` template by utilizing [addlicense](https://github.com/google/addlicense). + +```sh +addlicense -f ./license_header ./ +``` + #### Generate Go Code If your work requires re-generating the code (e.g. mock), please run `./gen.sh` at the project root. diff --git a/utils/cert_reload.go b/certreload/cert_reload.go similarity index 99% rename from utils/cert_reload.go rename to certreload/cert_reload.go index 941b706..6fd8d8a 100644 --- a/utils/cert_reload.go +++ b/certreload/cert_reload.go @@ -1,7 +1,7 @@ // Copyright 2024 Yahoo Inc. // Licensed under the terms of the Apache License 2.0. Please see LICENSE file in project root for terms. -package utils +package certreload import ( "bytes" diff --git a/utils/cert_reload_test.go b/certreload/cert_reload_test.go similarity index 99% rename from utils/cert_reload_test.go rename to certreload/cert_reload_test.go index be441b6..d8f71a6 100644 --- a/utils/cert_reload_test.go +++ b/certreload/cert_reload_test.go @@ -1,7 +1,7 @@ // Copyright 2024 Yahoo Inc. // Licensed under the terms of the Apache License 2.0. Please see LICENSE file in project root for terms. -package utils +package certreload import ( "crypto/tls" diff --git a/utils/generate_test.go b/certreload/generate_test.go similarity index 96% rename from utils/generate_test.go rename to certreload/generate_test.go index fc557a7..70c1ed3 100644 --- a/utils/generate_test.go +++ b/certreload/generate_test.go @@ -1,7 +1,7 @@ // Copyright 2022 Yahoo Inc. // Licensed under the terms of the Apache License 2.0. Please see LICENSE file in project root for terms. -package utils +package certreload //go:generate certstrap init --passphrase "" --common-name "ca" --years 80 //go:generate certstrap request-cert --passphrase "" --common-name client diff --git a/utils/testdata/ca.crt b/certreload/testdata/ca.crt similarity index 100% rename from utils/testdata/ca.crt rename to certreload/testdata/ca.crt diff --git a/utils/testdata/client.crt b/certreload/testdata/client.crt similarity index 100% rename from utils/testdata/client.crt rename to certreload/testdata/client.crt diff --git a/utils/testdata/client.key b/certreload/testdata/client.key similarity index 100% rename from utils/testdata/client.key rename to certreload/testdata/client.key diff --git a/license_comment b/license_header similarity index 94% rename from license_comment rename to license_header index 76ca316..bfad0a1 100644 --- a/license_comment +++ b/license_header @@ -1,2 +1,4 @@ +# lice + Copyright 2024 Yahoo Inc. Licensed under the terms of the Apache License 2.0. Please see LICENSE file in project root for terms.