philc / philc/vimium

keycodes are not in the wiki

Open
#4,593 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
27k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

If we want to customize the keymaps, we should be able to quickly see the key codes to see what we want to use and how.

The default ones are set here and we can use the keyboard binding reference, the rest of them are still in the code, so it's harder to reach and use; which, btw while they are a bit intuitive, it would be great to have a brief explanation.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the keyboard binding reference and the linked sections of background_scripts/commands.js, especially the default keymaps and remaining key codes. Identify the codes not covered in the reference and document them in the wiki with brief explanations. Done means the key codes are easy to find and understand for users customizing keymaps.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.