quickwit-oss / quickwit-oss/quickwit
[Documentation] out of date makefile comment
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 11.7k
- Forks
- 597
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 37
Description
Documentation issue
There's a seemingly out of date Makefile comment that is confusing,
https://github.com/quickwit-oss/quickwit/blob/f9a249a2705b4e9de1b9da1d979a081325a2b900/Makefile#L76
Looking at #237, I get a conflicting message that this is no longer a TODO. I'm not sure what the intended expected path is; it just seems like there are conflicting informations.
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
Open the Makefile at the linked commit and inspect the comment around line 76, then read issue #237 to compare the two descriptions. Determine the current intended behavior from those references and update the comment so it no longer conflicts with the project’s status; confirm the resulting wording is consistent with both sources.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100