<provider-kind> name in CaskSecret is inconsistent with GenerateKey
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 6
- Forks
- 6
- Avg merge
- 8d 10h
- Merged PRs (30d)
- 4
Description
docs/CaskSecret.md defines the field <provider-kind>:
The <provider-kind> name is inconsistent with "Provider key kind" in GenerateKey Pseudo-Code:
and with the char providerKeyKind parameter in the Cask.GenerateKey API:
I suggest renaming it to <provider-key-kind>. That name will also make it clearer that the same provider can define several different values for this field.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the definition in docs/CaskSecret.md and compare it with the Provider key kind wording in docs/GenerateKeyPseudoCode.md and the providerKeyKind parameter in src/Cask/Cask.cs. Rename the CaskSecret field consistently to and verify that the referenced terminology matches across these files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100