Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Focus commit input box after SCM commit action #859

Merged
merged 3 commits into from
Sep 30, 2021
Merged

Conversation

mattseddon
Copy link
Member

@mattseddon mattseddon commented Sep 30, 2021

From talking with Alexander yesterday I think that we want to cut down the number of clicks / actions to get users through particular workflows.

In the SCM view we currently have a commit button which runs dvc commit (for the entire repository) but then stops. In this PR I have made the cursor jump to the git commit inputBox once the user has dvc committed their DVC changes. This should serve to educate users that they still have to enter a commit message and commit to git once they have run dvc commit.

Thought process for this going with this approach:

  1. It is fairly simple.
  2. We don't have to clutter the UI further with our own input box (we had this previously and it was confusing IMO).
  3. We do not need to run any git actions in the background.
  4. We are integrating with something that is already there.
  5. Works well for the happy path.
  6. User can still use the UI to stage some files and commit only those if they want to.
  7. If the user chooses to enable the git.enableSmartCommit option then it is fairly quick.

IMO if you watched a 30 second video explaining the flow it would make the whole process / underlying DVC semantics more intuitive. LMK what you think.

Demos

Without git.enableSmartCommit (this can be enabled by clicking "always" from the second popup):

Screen.Recording.2021-09-30.at.11.16.13.am.mov

With git.enableSmartCommit:

Screen.Recording.2021-09-30.at.11.17.46.am.mov

Relates to #609.

@mattseddon mattseddon added the product PR that affects product label Sep 30, 2021
@mattseddon mattseddon self-assigned this Sep 30, 2021
@codeclimate
Copy link

codeclimate bot commented Sep 30, 2021

Code Climate has analyzed commit b2651bc and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (85% is the threshold).

This pull request will bring the total coverage in the repository to 96.0% (0.0% change).

View more on Code Climate.

@mattseddon mattseddon marked this pull request as ready for review September 30, 2021 01:33
@mattseddon mattseddon merged commit d9056b6 into master Sep 30, 2021
@mattseddon mattseddon deleted the jump-to-scm-box branch September 30, 2021 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product PR that affects product
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants