prometheus / prometheus/common
expfmt should parse HELP text
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 295
- Forks
- 367
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 18
Description
See: https://github.com/prometheus/prometheus/issues/4602
promtool is using expfmt https://github.com/prometheus/prometheus/blob/master/util/promlint/promlint.go#L68 which doesn't check the HELP text.
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
Read the linked Prometheus issue and the promlint.go usage of expfmt at the referenced line, then trace how HELP text is currently handled. Confirm the expected parsing and validation behavior from those references; done means expfmt checks HELP text as required by the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100