Align with the OSC Documentation Policy #6446
Conversation
| @@ -1 +1,132 @@ | |||
| See https://github.com/input-output-hk/cardano-engineering-handbook/blob/main/CODE-OF-CONDUCT.md | |||
| # Contributor Covenant Code of Conduct | |||
There was a problem hiding this comment.
| @@ -0,0 +1,18 @@ | |||
| # Security Policy | |||
There was a problem hiding this comment.
| @@ -0,0 +1 @@ | |||
| TODO | |||
There was a problem hiding this comment.
The OSC governance policy expects a DESCRIPTION file.
However, this is redundant as all information is already included in the README file.
Also, the OSC Documentation Repo itself doesn't have a DESCRIPTION file.
I'm unsure what to do here. Is the DESCRIPTION file really necessary?
There was a problem hiding this comment.
Maybe the safest bet would be to just add the redundant information here? I'm not sure what this standardised repository structure will be used for, maybe to provide some automation as well? In that case, not having any info in this file might break things, but again this is just a guess on how things will be used.
I have no idea why they don't follow their own rules, though!
LICENSE
Outdated
| 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. | ||
|
|
||
| END OF TERMS AND CONDITIONS | ||
| Apache License |
There was a problem hiding this comment.
Replaces with this license as per the policy. It's the same contents, just different formatting
| @@ -0,0 +1,11 @@ | |||
| # Plutus Codeowners | |||
There was a problem hiding this comment.
Note that this is a special file in GitHub.
It automatically add reviewers to PRs according to which files are modified.
For example I will be added as reviewer when files in /nix/ or flake.nix are modified.
While IntersectMBO/plutus-core-maintainers will be added as reviewer in all other cases.
There was a problem hiding this comment.
I just realised something: this will block merging unless it gets reviewed by the specific code owner, right? Since you're the only code owner for the nix code, it might make sense to add someone else as well in case you're unavailable.
There was a problem hiding this comment.
Interesting questions, I'm not sure.
I also don't know how CODEOWNER rules will play with existing PR & Merge rules.
We can just try it like this and see what happens?
There was a problem hiding this comment.
Does the OSC policy require there be a code owner for everything? I doubt adding plutus-core-maintainers to every PR is a good idea.
| @@ -0,0 +1,11 @@ | |||
| Copyright 2024 Intersect MBO | |||
There was a problem hiding this comment.
| @@ -0,0 +1,201 @@ | |||
| Apache License | |||
There was a problem hiding this comment.
| @@ -0,0 +1 @@ | |||
| TODO | |||
There was a problem hiding this comment.
Maybe the safest bet would be to just add the redundant information here? I'm not sure what this standardised repository structure will be used for, maybe to provide some automation as well? In that case, not having any info in this file might break things, but again this is just a guess on how things will be used.
I have no idea why they don't follow their own rules, though!
CHANGELOG.md
Outdated
| - [plutus-ledger-api](./plutus-ledger-api/CHANGELOG.md) | ||
| - [plutus-tx](./plutus-tx/CHANGELOG.md) | ||
| - [plutus-tx-plugin](./plutus-tx-plugin/CHANGELOG.md) | ||
| - [plutus-core](./plutus-core/CHANGELOG.md) |
There was a problem hiding this comment.
Unrelated to this PR, I find it strange that we also release prettyprinter-configurable but it doesn't have a changelog. @IntersectMBO/plutus-core-maintainers any idea why this is?
There was a problem hiding this comment.
We hope to extract it into a separate library and publish it on Hackage some time, so that we don't need to keep it in the Plutus repo at all.
Add top-level files in alignment with the OSC Documentation Policy.
See #6423