google / google/vim-codefmt

Create codefmt usage screencast for README.md

Open
#25 3 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Vim Script
Stars
1.1k
Forks
102
PR merge metrics
No merged PRs in 30d

Description

Lots of vim plugins have fancy screencasts (animated GIFs) in the README.md showcasing plugin features. The codefmt plugin has several useful features that would make a nice screencast.

We should create a screencast and embed it in our README.md. If we could also include a keyboard monitor in the screencast, that would help show off all the handy mappings.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing README.md and the codefmt plugin's documented features and mappings to choose what the screencast should demonstrate. Create the screencast with a keyboard monitor, embed it in README.md, and verify that the result clearly showcases the plugin's useful features.

Written by the indexing model from the issue text.

Assessment

Tech stack
vim
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.