How do we want to document clang-tidy and clang-format config options?
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 74
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
Would it be useful to add documentation in the config files about different clang-tidy options for example? Or would we rather document in a readme?
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 locating the clang-tidy and clang-format configuration files and any README documentation in the repository. Compare the available places for explaining configuration options, then clarify which options need coverage and whether documentation belongs in the config files or README. Done means the project has an agreed documentation location and the relevant options are documented there.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100