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.

Sign up for GitHub

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

Jump to bottom

Add GPL header to autobuild scripts #3077

Merged
merged 1 commit into from
Jul 24, 2023
Merged

Add GPL header to autobuild scripts #3077

merged 1 commit into from
Jul 24, 2023

Conversation

ann0see
Copy link
Member

@ann0see ann0see commented Jun 5, 2023 •
edited
Loading

Short description of changes

Adds GPL header to Autobuild scripts
CHANGELOG: Internal: Clarify licensing terms for Autobuild scripts

Context: Fixes an issue?
Fixes: #3026

Does this change need documentation? What needs to be documented and how?
I don't think so.

Status of this Pull Request
Ready for review - and discussion. I'd like to hear @hoffie here.

What is missing until this pull request can be merged?
Test by CI

Checklist

  • I've verified that this Pull Request follows the general code principles
  • I tested my code and it does what I want
  • My code follows the style guide
  • I waited some time after this Pull Request was opened and all GitHub checks completed without errors.
  • I've filled all the content above

AUTOBUILD: Please build all targets

@ann0see ann0see added this to the Release 3.10.0 milestone Jun 5, 2023
@ann0see ann0see requested a review from hoffie June 5, 2023 19:17
@ann0see
Copy link
Member Author

ann0see commented Jun 5, 2023

This would also need to be added to the copyright notices update script...

@pljones
Copy link
Collaborator

pljones commented Jun 11, 2023

It might be worth updating the style guide to state any new code contribution should have the appropriate licence stated at the start of its body text, either under this PR or separately.

@ann0see ann0see self-assigned this Jul 1, 2023
@ann0see
Copy link
Member Author

ann0see commented Jul 1, 2023

@pljones

I've now updated and rebased the files. I think the tools/ directory also needs licensing.

@pljones
Copy link
Collaborator

pljones commented Jul 2, 2023

I think the tools/ directory also needs licensing.

Worth raising a 3.11.0 issue for that, I guess.

@ann0see
Copy link
Member Author

ann0see commented Jul 2, 2023 •
edited
Loading

I believe that's still covered in my linked issue.

Maybe also in scope of this PR

ann0see
ann0see commented Jul 10, 2023
View reviewed changes
Copy link
Member Author

@ann0see ann0see left a comment

Choose a reason for hiding this comment

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

Ah. Still needs an update in the tools/update-copyright-notices.sh file

@ann0see ann0see force-pushed the licensing/addGPLHeader branch 3 times, most recently from 8329fc6 to 94f9719 Compare July 12, 2023 20:43
@ann0see
Copy link
Member Author

ann0see commented Jul 12, 2023 •
edited
Loading

@pljones I've now added the notes to the tools directory too and updated the copyright updating script. I've tested .pl, .py and .sh files and all get updated correctly.

pljones
pljones reviewed Jul 13, 2023
View reviewed changes
CONTRIBUTING.md Outdated
@@ -46,6 +46,9 @@ Please install and use [pylint](https://pylint.org/) to scan any Python code.
There is a configuration file that defines some overrides,
and note the [Editorconfig file](.editorconfig) in the project too.

### Licensing

If you add new (source code) files, please add a header with the license to the file. This clarifies how your work is licensed.
Copy link
Collaborator

@pljones pljones Jul 13, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

We should say what the header MUST include:

  • Legal copyright line
  • Author(s) list
  • Declaration of licence, indicating how to refer to the full text if not provided in full

Someone who knows more about this should confirm the above but I think that's why we have what we have.

ann0see
ann0see commented Jul 15, 2023
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@ann0see @pljones
Add GPL header to scripts
c9ddad0 
This also adds a comment to the CONTRIBUTING guidelines

Co-authored-by: pljones <pljones@users.noreply.github.com>
@ann0see ann0see requested a review from pljones July 22, 2023 18:37
@ann0see
Copy link
Member Author

ann0see commented Jul 23, 2023

@pljones please merge if you feel it's ok.

@pljones pljones merged commit 1736d2a into jamulussoftware:main Jul 24, 2023
17 checks passed
@ann0see ann0see deleted the licensing/addGPLHeader branch July 24, 2023 19:08
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hoffie hoffie Awaiting requested review from hoffie

@pljones pljones Awaiting requested review from pljones

Assignees

@ann0see ann0see

Labels
None yet
Projects
Tracking
Status: Done
Milestone
Release 3.10.0
Development

Successfully merging this pull request may close these issues.

Add clear GPL license header to missing scripts like autobuild
2 participants
@ann0see @pljones