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

Added a CHANGELOG.md and CONTRIBUTING.md documentation #250

Merged
merged 4 commits into from
Oct 6, 2024

Conversation

jaredponn
Copy link
Collaborator

@jaredponn jaredponn commented Sep 24, 2024

This PR:

  • added an empty CHANGELOG.md for all of LB
  • added a CONTRIBUTING.md which is an abridged version of tx-village's change log.

Copy link
Collaborator

@bladyjoker bladyjoker left a comment

Choose a reason for hiding this comment

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

This is great and am certain probably sufficient.

I'd like to have the following somehow done;

# LB v.1.0.0

## Schemas

lbf-prelude v.1.0.0
  - Purescript
     - <lib.ver> of the libraries hosting the types and implementations (basically from the codegen config)  
   - Rust
   - Haskell
   - Typescript

lbf-plutus v.1.0.0 
  - Purescript
     - <lib.ver> of the libraries hosting the types and implementations (basically from the codegen config)  
   - Rust
   - Haskell
   - Typescript
   - Plutarch
   - PlutusTx

## Tools

Frontend v.1.0.0
Compiler v.1.0.0
   - Proto API v.1.0.0
Codegen v.1.0.0
   - Proto API v.1.0.0

## Runtimes

Rust lbr-prelude v.1.0.0
Haskell lbr-prelude v.1.0.0
Typescript lbr-prelude v.1.0.0
 
Rust lbr-plutus v.1.0.0
Haskell lbr-plutus v.1.0.0
PlutusTx lbr-plutus v.1.0.0
Plutarch lbr-plutus v.1.0.0
Typescript lbr-plutus v.1.0.0

Basically our repo wide version and how does it reflect the underlying versions of schemas, the libraries they map to, runtimes, tools and their external APIs.

I suspect we should writeup how the versioning numbers change and stay aligned (it at all) between all this parts.

And also we should update the Cabal,Dhall,Cargo,Proto,LB build configurations and specify the versions explicitly if not already so.

I don't have the cycles to be more precise about this tbh, so whatever you can do here it's good enough!

@szg251
Copy link
Collaborator

szg251 commented Oct 2, 2024

I think we need to adjust the versioning, as PVP is only appliable to Haskell (and PureScript I guess).
My strategy for polyglot repos is to set the first number of the PVP version to 1 all times, so the versions can be consistent:
e.g.: semver 7.8.0 -> PVP 1.7.8.0
with the exception of preproduction versions, which can start with a 0
See the contribution guideline here https://github.com/mlabs-haskell/plutus-ledger-api-rust/blob/main/CONTRIBUTING.md, and oc feel free to propose changes.

@jaredponn
Copy link
Collaborator Author

@szg251 right, I see what you're saying now about the prefixing all PVP with 1 or 0.

I copied exactly what was written for your versioning scheme with the following changes:

  • I didn't enforce an alignment between versions of the entire repo and its subparts. It seems to me that forcing an alignment of major version numbers would contradict the fact that we bump the major version numbers only if there is a breaking change.
  • Instead of having a CHANGELOG.md for each subproject, we have a CHANGELOG.md for everything at the root of the project. I dunno what's better, but we'll see with time what works out :)

jared added 2 commits October 5, 2024 16:50
monorepo setup, and changed all Haskell libraries from `0.a.b.c` to
`1.a.b.c` as per the versioning requirements
@jaredponn
Copy link
Collaborator Author

I'm going to merge this s.t. we can get the Milestone 4 write up finalized, and if we have any other changes we'd like (I'm sure we'll find some!) we can put it in a separate PR :P.

@jaredponn jaredponn added this pull request to the merge queue Oct 6, 2024
Merged via the queue into main with commit 2d2283c Oct 6, 2024
2 checks passed
@jaredponn jaredponn deleted the jared/versioning-docs branch October 6, 2024 06:03
@jaredponn jaredponn linked an issue Oct 9, 2024 that may be closed by this pull request
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Versioning
3 participants