Skip to content
This repository has been archived by the owner on Jun 8, 2022. It is now read-only.

Design of initial version. #1

Open
ffranr opened this issue Sep 17, 2019 · 4 comments
Open

Design of initial version. #1

ffranr opened this issue Sep 17, 2019 · 4 comments
Assignees

Comments

@ffranr
Copy link
Member

ffranr commented Sep 17, 2019

This issue outlines the design of the very first basic direction of development. In future work, the following commands may well be extended beyond what is proposed here.

Status Command

git crev status

Prints out the total number of commits reviewed and un-reviewed for the current working directory git repo. Indicates whether a review is ongoing.

Review Commands

Add commits to a review

git crev add <git revision range>

Initiates the construction of a review (if none is currently ongoing). Adds the commits in <git revision range> to the review. Default revision range is HEAD.

Remove commits from a review

git crev remove <git revision range>

Removes the commits in <git revision range> from an ongoing review. Default revision range is HEAD.

Clear current review

git crev clear

Remove all commits from an ongoing review.

Commit and sign the review

git crev commit

Sign an ongoing review and thereby create a proof. Ends an ongoing review.

@ffranr ffranr self-assigned this Sep 17, 2019
@ffranr
Copy link
Member Author

ffranr commented Sep 17, 2019

@dpc What do you think about this sort of direction?

@dpc
Copy link

dpc commented Sep 17, 2019

Personally, I'm not a big fan of stateful CLI UIs and it shows in cargo crev. git UI is very stateful though. Combining git + crev is going to be inconsistent with one or the other. 😆 But git UI is so inconsistent that no one is going to mind anyway... 😆

I guess trying to appeal to git users makes sense. But I don't see the overreaching idea here. I would expect ... add <range> and ... commit or something like that?

@dpc
Copy link

dpc commented Sep 17, 2019

One way or another, I would just dive into implementing what you want, and try to collect feedback from more people once there's something more material to work with. :)

@ffranr
Copy link
Member Author

ffranr commented Sep 18, 2019

That makes sense! I've updated the design, but now I'm just going to just work on an implementation.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants