Write a codefmt FAQ
Open
Beginner friendly
enhancement
- Dominant language
- Vim Script
- Stars
- 1.1k
- Forks
- 102
- PR merge metrics
- No merged PRs in 30d
Description
Codefmt raises a few questions like [why not just use formatprg](https://www.reddit.com/r/vim/comments/2uab1g/codefmt_a_plugin_for_formatting_code_using/co6lljx) that we should officially answer in the docs, pbb in README.md.
I added a bit of FAQ content to https://github.com/google/vim-codefmt/wiki/Formatter-Integration-Guide. Part or all of that can be merged into a main FAQ.
Contributor guide
Research direction
Review README.md and the existing FAQ content in the Formatter Integration Guide, including the linked question about why to use codefmt instead of formatprg. Consolidate the relevant answers into a main FAQ in the README, with the FAQ covering the questions users are likely to have.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- vim
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100