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.

Sign up for GitHub

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

Jump to bottom

Beta Cleanup #66

Open
2 of 16 tasks
nothingismagick opened this issue Mar 10, 2021 · 0 comments
Open
2 of 16 tasks

Beta Cleanup #66

nothingismagick opened this issue Mar 10, 2021 · 0 comments

Comments

@nothingismagick
Copy link
Contributor

nothingismagick commented Mar 10, 2021 •
edited
Loading

Description

In anticipation of the forthcoming beta release, we will need to make sure that we have done a number of things:

Meta

  • Add and use CODEOWNERS file

Cargo.toml

  • Allocate authorship of crate to IOTA Foundation
  • Cleanup and group dependency ordering
  • Verify that all dependencies are up to date
  • Supply a proper software BOM

Documentation

  • Add crate level introduction to lib.rs
  • Catch missing docs #![warn(missing_docs)]

Readme

  • Readme that defines the library
  • Must reference license
  • Should be ref'd in the Cargo.toml
  • When published, should have a crates.io badge
  • Should provide a link to the CHANGELOG (top level should link to ALL changelogs)

CI

  • Should also run examples (if feasible)
  • Audit all external workflows
  • Do more careful checks for running tests (e.g. don't need to run tests if we only change the README)

ARCHITECTURE.md

  • We need a very verbose explanation of the architecture from a general perspective as well as go into detail about each feature and what it does.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nothingismagick