Document well-known file header in readme
Open
- Dominant language
- C++
- Stars
- 9.9k
- Forks
- 544
- PR merge metrics
- No merged PRs in 30d
Description
Can you document this well-known file header in the project readme?
https://github.com/dependabot/dependabot-core/issues/4475#issuecomment-1416353842
It'd help avoid me looking like an idiot in https://github.com/dependabot/dependabot-core/issues/4475#issuecomment-1413185642. 😁
Contributor guide
Research direction
Read the linked Dependabot issue comments to identify the well-known file header being discussed, then inspect the project README. Document that header in the README and confirm the explanation matches the referenced discussion.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100