jonhoo / jonhoo/rust-imap

Conform to the Rust API guidelines

Open
#100 1 comment 0 reactions 0 assignees View on GitHub
enhancement good first issue help wanted tombstone
Dominant language
Rust
Stars
583
Forks
94
PR merge metrics
No merged PRs in 30d

Description

While `0.9` made some significant improvements to the `imap` crates' interface, we still have some way to go. In particular, we should go through the [Rust API guidelines checklist](https://rust-lang-nursery.github.io/api-guidelines/checklist.html) and do the best we can to match its recommendations. I think this is probably a blocker for 1.0.

See the original issue here: https://github.com/mattnenterprise/rust-imap/issues/100

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the Rust API guidelines checklist and comparing its recommendations with the public interfaces of the imap crates. Record which recommendations apply and identify the affected APIs; done would require addressing the applicable gaps and verifying that the crates conform consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
backend-api-design
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.