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

Added copyright notice to all .swift files (#391) #403

Merged
merged 3 commits into from
Mar 9, 2024

Conversation

Jag-Marcel
Copy link
Member

Contributor checklist


Description

Added a generic copyright notice to all .swift files in the directory, with a short description for each file. For those that already had a description, I just copied the existing one; for others, I came up with one to the best of my abilities.

Related issue

Added a generic copyright notice to all .swift files in the directory, with a short description for each file.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey!! 👋

Just wondering about something here..
How would we plan on maintaining this license header in all the relevant files? Not sure if some automation was used to make the changes in this PR, but could there be something like .editorconfig that we could use to generate these (especially if we'd like to tweak the text in the future)?

CC: @andrewtavis

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any level of automation would be appreciated for this. I believe that @Jag-Marcel was going through individually as this was also a task of better understanding the codebase. The file headers also have a description of the file, which we thought was important. Could you send along an example of how the license could be automated with this, @wkyoshida?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like this might be possible with Xcode perhaps (ref)? I don't have Xcode to be able to validate if this works though..

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be a bit more for changing the default for when the file is made, but maybe I'm not reading it clearly 🤔 Would be good to include though! I'd say it's a different issue though.

// UIColor+ScribeColors.swift
//
/**
* Adds Scribe colors to the UIColor pool
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor change request on this, @Jag-Marcel, could we put a period at the end of all of the descriptions and just have one line after it instead of two?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure! I'll get on it

Added a period at the end of the descriptions at the top of each .swift file and removed the extra newline after it.
(used sed for this)
Copy link
Member

@andrewtavis andrewtavis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just finished going through all these, @Jag-Marcel 🚀 Thanks so much for the hard work here and the quick edits 👏 Let me know if you have interest in working on #405, and aside from that we can find the next issue for you :)

@andrewtavis andrewtavis merged commit 26f8a39 into scribe-org:main Mar 9, 2024
@Jag-Marcel Jag-Marcel deleted the copyright-notice branch July 11, 2024 15:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants