naming: `CertifiedKey` is confusing

Open
#391 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
cryptography

Research direction

Start by locating the CertifiedKey definition and every reference to it in the rcgen repository. Check whether CertificateWithKey or another name best matches the intended meaning, then update the affected references and verify the project tests pass.

Written by the indexing model from the issue text.

Description

CertifiedKey reads like "a key that is (somehow) certified", when we actually mean "a certificate together with the key(pair) used to sign it".

Perhaps CertificateWithKey would be fine?

Dominant language
Rust
Stars
516
Forks
160
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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 rustls/rcgen

All issues in rustls/rcgen

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.