caddyserver / caddyserver/certmagic
Make field names consistent
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 5.6k
- Forks
- 354
- Avg merge
- 9d 23h
- Merged PRs (30d)
- 3
Description
"challenge" vs. "challenge_type"... "identifier" vs. "identifiers"... etc.
For identifier/identifiers, we might need to make them all plural (arrays, even if only 1?) or for some of them perhaps users will just have to query like identifier = X OR contains(identifiers, X)... I dunno.
Using consistent field names make querying easier overall.
(Feedback from a sponsor.)
Contributor guide
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 by inventorying the public fields represented by the examples “challenge”/“challenge_type” and “identifier”/“identifiers,” then determine whether singular values should become arrays or require separate query handling. Done means the naming policy is decided and applied consistently across the affected fields, with querying behavior documented or covered by the relevant checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- 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