browsh-org/browsh

Help with testing vim-mode-experimental

Open

#233 opened on Nov 1, 2018

View on GitHub
 (5 comments) (6 reactions) (1 assignee)JavaScript (15,996 stars) (455 forks)batch import
enhancementhelp wantedtty-mode

Description

The branch vim-mode-experimental needs testers and contributors.

Follow the build guides provided in the README.md and git checkout vim-mode-experimental.

Keybindings aren't configurable yet, but that's going to change. Keybindings are the same ones vimium has, except for closing tabs being bound to xx instead of x, to prevent accidental closing. You can look into config.go for all features and change hardcoded bindings to your liking.

The find feature doesn't work fully, because it doesn't scroll. The focus first input box feature is a stub currently, but f (link hinting) also works for selecting input boxes, so this shouldn't be a big issue.

You can use vc (visual mode > caret mode) to try caret mode navigation, where you click with Enter

Tests for the different features are missing, so this is certainly one way in which you could help, by writing tests.

The vim-mode-experimental branch breaks a few tests, and I know the cause for most of them. Will fix that hopefully soon.

If you run into bugs with this branch, please report them.

Feedback welcome!

Contributor guide

Tech stack
go
Domain
frontendcli
Issue type
test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Go programmingvim keybindingstesting in Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Start by reading the README.md and config.go in the vim mode experimental branch to understand current features and hardcoded keybindings. The issue mentions that tests are missing for various features like find scrolling, caret mode, and link hinting. Look at existing test files in the repository for patterns. The find feature needs scrolling implementation, and the focus first input box is a stub. Also note that the branch breaks some tests already. Focus on writing tests for one feature at a time, such as caret mode navigation (use vc). Check if there are any open conversations or linked PRs for guidance.