vdf-rs icon indicating copy to clipboard operation
vdf-rs copied to clipboard

Pre-release checklist

Open CosmicHorrorDev opened this issue 3 years ago • 3 comments

  • [x] Get CI setup to test on all 3 major platforms
    • [x] cargo check
    • [x] cargo fmt
    • [x] cargo clippy
    • [x] cargo test
    • [x] Use a basic tester for most of these then run tests on MSRV, stable, and beta
    • [x] Automate releases by pushing tags (need separate tags for each library?)
  • [x] Figure out MSRV (document this)
  • [x] Document everything
    • [x] Add in doc comments
    • [x] Update all READMEs
  • [x] Re-export common components and double-check public things
  • [x] Update all dependencies
  • [x] ~~Add in conversions between all main types from the parser~~ (tokenstream is being kept behind unstable feature for initial release)
  • [x] Check through all the TODOs left throughout the repo
  • [x] Move tokenstreams behind unstable feature flag
  • [x] Update benchmarks

Post-Release

  • [ ] Update any placeholder links to documentation
  • [ ] Badge swag

Pushed Off

  • [ ] Add in GitHub requested documentation
  • [ ] Add a doc explaining assumptions from VDF representations
  • [ ] Double-check method names and see where traits could be used instead
  • [ ] Go through the official release checklist

CosmicHorrorDev avatar May 20 '21 05:05 CosmicHorrorDev