Write a codefmt FAQ
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- vim
- Domain
- documentation
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.
Description
Codefmt raises a few questions like why not just use formatprg 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.
- Dominant language
- Vim Script
- Stars
- 1.1k
- Forks
- 102
- PR merge metrics
- No merged PRs in 30d
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.
More from google/vim-codefmt
-
Add meson format Opennew formatter
Difficulty 3/5 1-2 days Newbie friendliness 45/100
google/vim-codefmt#243 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 52/100
google/vim-codefmt#240 · 1 comment ·
-
Add `:CodefmtInfo` command to report diagnostics to help users check config / diagnose problems Openenhancement
Difficulty 5/5 Over a week Newbie friendliness 35/100
google/vim-codefmt#234 · 2 comments ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 45/100
google/vim-codefmt#222 · 3 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
google/vim-codefmt#217 · 7 comments · 1 reaction ·
All issues in google/vim-codefmt
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100