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

Add license information at the top of each Scribe file #391

Closed
2 tasks done
andrewtavis opened this issue Jan 13, 2024 · 3 comments
Closed
2 tasks done

Add license information at the top of each Scribe file #391

andrewtavis opened this issue Jan 13, 2024 · 3 comments
Assignees
Labels
help wanted Extra attention is needed

Comments

@andrewtavis
Copy link
Member

andrewtavis commented Jan 13, 2024

Terms

Issue

Based on a comment in #384, it looks like something we're missing for the GPL license is a notice at the top of each file. The directions for releasing GPL based code can be found here. It would be good for us to check what else is required and expand this issue to include other elements we're missing.

Happy to discuss this with people and implement parts of it once we've figured out all the changes that are needed!

@andrewtavis andrewtavis added the help wanted Extra attention is needed label Jan 13, 2024
Jag-Marcel added a commit to Jag-Marcel/Scribe-iOS that referenced this issue Feb 9, 2024
Added the copyright notice to the files I edited in this PR.
@Jag-Marcel
Copy link
Member

Jag-Marcel commented Feb 10, 2024

Currently my idea would be to add something like this to every file:

/**
 * [Short description
 * of the file]
 * 
 * Copyright (C) 2023-2024 Scribe
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

The short description would be something like "This file controls outlets to the buttons on the 'About' page of the app" (for AboutTableViewCell.swift); the rest is the same I found on other files that already had a license notice.

@andrewtavis
Copy link
Member Author

Sounds great to me, @Jag-Marcel! Appreciate you taking this on :) If you need any help with the file descriptions, then just let me know. Also happy to do some of those if you're not sure 😊

andrewtavis added a commit that referenced this issue Mar 9, 2024
Added copyright notice to all .swift files (#391)
@andrewtavis
Copy link
Member Author

Closing this up 🥳 Thanks for all this, @Jag-Marcel!

SaurabhJamadagni pushed a commit to marekviktor/Scribe-iOS that referenced this issue Apr 18, 2024
Added the copyright notice to the files I edited in this PR.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
Archived in project
Development

No branches or pull requests

2 participants