Document how to use clang-format with VSCode
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Dockerfile
- Stars
- 1
- Forks
- 2
- Avg merge
- 22m
- Merged PRs (30d)
- 4
Description
Our repos use clang-format for for formatting source code. VSCode will automatically run clang-format for you on save (can't remember if that was the default or not). Assuming it doesn't just work out of the box, we should add to the documentation how to get VSCode to run clang-format.
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 reviewing the repository's existing documentation and the issue's VSCode and clang-format setup requirements. Add a clear setup guide for running clang-format on save in VSCode, and verify that the documented steps work for a newcomer.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- vscode
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100