-
Notifications
You must be signed in to change notification settings - Fork 0
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
Conversation
There was a problem hiding this 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!
I think we need to adjust the versioning, as PVP is only appliable to Haskell (and PureScript I guess). |
b5b66ce
to
3257d49
Compare
@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:
|
monorepo setup, and changed all Haskell libraries from `0.a.b.c` to `1.a.b.c` as per the versioning requirements
3257d49
to
0e6ad9e
Compare
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. |
This PR:
CHANGELOG.md
for all of LBCONTRIBUTING.md
which is an abridged version of tx-village's change log.