-
Notifications
You must be signed in to change notification settings - Fork 3
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 maintainability of source code files #747
Comments
we'll go with the option to remove the copyright piece from the source files. i'll open an example PR to a repo of what the change will look like for the other repos. |
I wonder if it could be automated |
oh yes. it will be. i just want to make sure i understand what the change will look like. in fact. i'm wondering about replacing our standard three-liner in our code files:
with a SPDX identifier, such as:
more info: https://spdx.dev/ids/#why In our README's in the repos, also looking to reduce:
to just:
do you have any thoughts on those tweaks? |
The README I am less sure of (and since there is only one it doesn't matter as much to me), but I like the file name change |
Here's an example of the changes I was thinking to make: go-vela/vela-email#41. couple of callouts:
the remainder of the changes are pretty uncontroversial, i think. |
i think this is good to be closed |
Description
Clean up source code files throughout Vela to make them more maintainable.
Value
Reduce future notification noise and maintenance cost
Definition of Done
I don't know the product very intimately, but I guessed at a scope:
Team to decide on course of action. I worked with Legal to clarify:
Including a copyright notice with file each is not required
The year in the notice specifies the year of first publication. So there is no need to go back and update the year in existing files.
© 2022 Target Brands, Inc.
Do not specify
Copyright (c)
, this is redundant.Once an option is chosen (remove completely, update each file to state the year created only), change all files.
Address any linting or automation checking for current year.
Effort (Optional)
Impacted Personas (Optional)
The text was updated successfully, but these errors were encountered: