Misc cleanup (review by David)

Open
#104 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Active
Tech stack
rust
Domain
cryptography, documentation

Research direction

Start by locating the remaining name str definitions and reviewing the Factory crate, then check the completed references to CONTRIBUTING.md, CLAUDE.md, SHA2, and HMAC for context. Done means the remaining name strings are moved into the Factory crate without leaving the cleanup checklist incomplete.

Written by the indexing model from the issue text.

Description

  • Add the preference for squash merges to CONTRIBUTING.md
  • Make sure CLAUDE.md is pointing to CONTRIBUTING.md
  • Move all the name str's into the Factory crate.
  • Move the typedefs for HKDF_SHA256 and HKDF_SHA512 to the SHA2 crate.
    • Fix the docs ... probably that just means putting a docstring on those two typedefs that points back at the bouncycastle_hkdf crate docs.
    • Ditto for HMAC.
Dominant language
Rust
Stars
25
Forks
18
Avg merge
16h 38m
Merged PRs (30d)
3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from bcgit/bc-rust

All issues in bcgit/bc-rust

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.