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

CIP-9999 | Add mandatory Copyright + related cleanup #762

Merged

Conversation

rphair
Copy link
Collaborator

@rphair rphair commented Feb 8, 2024

Fixes #759.

In addition to mimicking the CIP licensing requirements for the CPS, this removes static LICENSE files from the CIPs that still had them in spite of the fact that linking the license in the document footer is (and is preferred to be) sufficient for license binding. (It also fixes that license link in one case that I missed in #389 "Remediation")

It might be less work to do the CPS license updates as part of this PR, but I think not because:

  • some CPS authors will want to consider CC vs. Apache, and others might by default leave that choice to editors
  • we could want to coordinate this with parsers for the Dev Portal and cips.cardano.org since currently undefined YAML header data might trigger warnings / errors / inappropriate formatting. cc @KtorZ @katomm

@rphair rphair added Update Adds content or significantly reworks an existing proposal Category: Meta Proposals belonging to the 'Meta' category. labels Feb 8, 2024
@rphair rphair marked this pull request as ready for review February 8, 2024 11:57
@Ryun1
Copy link
Collaborator

Ryun1 commented Feb 8, 2024

Do we want to add a License field to the CPS header?

@rphair
Copy link
Collaborator Author

rphair commented Feb 8, 2024

@Ryun1 you've spotted an interesting problem which I guess had always been a bother & didn't articulate till now. All along, the CIP has had License in the CIP header but has a Copyright section in the document. I believe this is proper... but I reflected the duplicate term when calling it Copyright in the description of the front matter data. I'll fix that now... plus the pending updates to the CPS template which I still haven't committed.

@rphair
Copy link
Collaborator Author

rphair commented Feb 8, 2024

... or maybe you mean this CPS header. That was actually one of the things I said should be delayed in the OP, if so... it would be bad if this file itself got omitted on the derived sites due to syntax errors. In any case will double-check all this stuff & update in next few minutes.

@rphair
Copy link
Collaborator Author

rphair commented Feb 8, 2024

OK @Ryun1 TL;DR last 2 comments: oversight you pointed out is fixed in ed51527

Copy link
Collaborator

@Crypto2099 Crypto2099 left a comment

Choose a reason for hiding this comment

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

Looks good

@Ryun1
Copy link
Collaborator

Ryun1 commented Feb 8, 2024

I meant, do we want to edit the CPS yaml header to have a License to match the CIPs yaml header?

@rphair
Copy link
Collaborator Author

rphair commented Feb 8, 2024

@Ryun1
Copy link
Collaborator

Ryun1 commented Feb 8, 2024

ahh sorry! I meant also in the template file

@rphair
Copy link
Collaborator Author

rphair commented Feb 8, 2024

@Ryun1
Copy link
Collaborator

Ryun1 commented Feb 8, 2024

Wait, am I being silly?
I cant see the License in the CPS yaml header. I can see it in the document sections but not the header.

so the header would be:

---
CPS: ?
Title: ?
Status: Open
Category: ?
Authors:
    - John Doe <[email protected]>
Proposed Solutions: []
Discussions:
    - https://github.com/cardano-foundation/CIPs/pull/?
Created: YYYY-MM-DD
License: CC-BY-4.0
---

@rphair
Copy link
Collaborator Author

rphair commented Feb 8, 2024

@Ryun1 you are not being silly but the purpose of this PR (posted in #762 (comment)) is deliberately not to modify any CPS headers for [my own] worry that it will break downstream tooling & could well require some coordination beyond the editorial "rules" set in this PR:

It might be less work to do the CPS license updates as part of this PR, but I think not because ... we could want to coordinate this with parsers for the Dev Portal and cips.cardano.org since currently undefined YAML header data might trigger warnings / errors / inappropriate formatting.

p.s. edit: and now I am being silly since I confused the document structure in the CPS with the sample in the Template file. So here I go again with one more commit & thanks again @Ryun1 for the double check 🤓

@rphair
Copy link
Collaborator Author

rphair commented Feb 8, 2024

License: CC-BY-4.0

OK @Ryun1 - done and done in ee096be I hope 😅

@rphair rphair merged commit cd99af1 into cardano-foundation:master Feb 15, 2024
Ryun1 pushed a commit to Ryun1/CIPs that referenced this pull request Feb 20, 2024
…ion#762)

* add mandatory Copyright to CPSs, clean up CIP License glitches

* missed License in CPS header

* add Copyright section also to CPS template

* adding License: tag also to CPS template YAML header
Ryun1 pushed a commit to Ryun1/CIPs that referenced this pull request Mar 6, 2024
…ion#762)

* add mandatory Copyright to CPSs, clean up CIP License glitches

* missed License in CPS header

* add Copyright section also to CPS template

* adding License: tag also to CPS template YAML header
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Meta Proposals belonging to the 'Meta' category. Update Adds content or significantly reworks an existing proposal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CIP-9999 | How to add Copyright to CPSs
3 participants