search

IntersectMBO / cardano-cli

This repository contains sources for the command-line interface (CLI) tool for interacting with the Cardano blockchain.
Apache License 2.0
37 stars 13 forks source link

Missing File Required by Governance #769

Closed Ranchhand87 closed 3 months ago

Ranchhand87 commented 3 months ago

This repo is missing CHANGELOG.MD

This document is required per OSC Governance. https://intersect.gitbook.io/open-source-committee/policies/governance

rdlrt commented 3 months ago

https://github.com/IntersectMBO/cardano-cli/blob/main/cardano-cli/CHANGELOG.md

smelc commented 3 months ago

cc @CarlosLopezDeLara

CarlosLopezDeLara commented 3 months ago

@smelc @Ranchhand87

CHANGELOG.MD for the cardano-cli package is in https://github.com/IntersectMBO/cardano-cli/blob/main/cardano-cli/CHANGELOG.md

Which seems to meet the requirement :

A CHANGELOG (if the project includes multiple packages or similar, then one CHANGELOG per package may be more appropriate)

We could put it at the top level since (for now) the repository includes only cardano-clipackage. I don't know if that move could break any of the scripts used in, for example, tagging or releasing cardano-cli.

Ranchhand87 commented 3 months ago

One Changelog per package is acceptable. If possible, a CHANGELOG.MD on the main page would be desirable, as it is easier to verify. If this would break the current systems, Please advise. Thanks!

carbolymer commented 3 months ago

Yeah that would break our release scripts. Can be a top level changelog a symlink to the cli's one: https://github.com/IntersectMBO/cardano-cli/tree/mgalazyn/chore/add-changelog ? PR: https://github.com/IntersectMBO/cardano-cli/pull/770

Ranchhand87 commented 3 months ago

@carbolymer That seems like a great approach. Creating a mainline Changelog that links to the more specific ones will work. Thank you.