CLDYCON-4294: Add copyright comments - Githubissues

cloudability / metrics-agent

From the cloud optimization professionals

https://www.cloudability.com/

Apache License 2.0

39 stars 35 forks source link

CLDYCON-4294: Add copyright comments #247

Closed aoneill01 closed 8 months ago

aoneill01 commented 8 months ago

What does this PR do?

Adds copyright comment to all go files
Update CONTRIBUTING.md with instructions

Where should the reviewer start?

Instructions in CONTRIBUTING.md

How should this be manually tested?

Each developer will need to run:

pre-commit install

Can manually run it against all files with:

pre-commit run --all-files

Any background context you want to provide?

Had to make some modifications to the provided headerScript.sh, including:

Space between // and © because of gofmt(?) convention
Append newline to ensure the comment is not considered a Go doc comment of the package line

What picture best describes this PR (optional but encouraged)?

What are the relevant Github Issues?

CLDYCON-4294

Developer Done List

[ ] Tests Added/Updated
[ ] Updated README.md
[ ] Verified backward compatible
[ ] Verified database migrations will not be catastrophic
[x] Considered Security, Availability and Confidentiality

For the Reviewer:

By approving this PR, the reviewer acknowledges that they have checked all items in this done list.

Reviewer/Approval Done List

[ ] Tests Pass Locally
[ ] CI Build Passes
[ ] Verified README.md is updated
[ ] Verified changes are backward compatible
[ ] Reviewed impact to Security, Availability and Confidentiality (if issue found, add comments and request changes)

aoneill01 commented 8 months ago

Not applying the copyright headers for this repository right now.