iotaledger / iotaledger/crypto.rs

Beta Cleanup

Open
#66 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
63
Forks
24
PR merge metrics
No merged PRs in 30d

Description

## 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
- [x] Readme that defines the library
- [ ] Must reference license
- [x] 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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.