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

Rename the --driver global option for consistency with forge naming #1142

Open
Tracked by #1073
0x2b3bfa0 opened this issue Sep 7, 2022 · 6 comments
Open
Tracked by #1073
Labels
discussion Waiting for team decision ui/ux User interface/experience

Comments

@0x2b3bfa0
Copy link
Member

0x2b3bfa0 commented Sep 7, 2022

After #1073 (comment), the --driver option should be renamed to whichever name we choose1 to describe forges.

Footnotes

  1. To my mind, --forge would be the mot juste. πŸ€·πŸΌβ€β™‚οΈ ↩

@0x2b3bfa0
Copy link
Member Author

β€œWhat generic term for β€˜GitHub/GitLab/Bitbucket’ do you think users will understand best?”

Top 5 choices of 9 based on an internal ad populum poll of @iterative members:

term votes percentage
git provider 16 46%
git host 12 34%
forge 3 9%
git forge 2 6%
git site 1 3%

@dacbd
Copy link
Contributor

dacbd commented Sep 9, 2022

unclear, discuss what you want to call GitHub Gitlab and bb sure, but functionally this option selects the correct lib to make and interrupt API calls and responses from said term; I believe that very much meets the definition of driver in the context of cml

@0x2b3bfa0
Copy link
Member Author

functionally this option selects the correct lib to make and interrupt API calls and responses from said term

Sure, but that's an implementation detail. πŸ™ƒ

I believe that very much meets the definition of driver in the context of cml

That's how it's being named in CML internals, indeed, but from a user experience1 standpoint it's rather meaningless.

Footnotes

  1. Not to mention developer experience, but that's for another day. ↩

@0x2b3bfa0
Copy link
Member Author

Scope clarification: this issue is mostly about renaming --driver to something else that's more descriptive and bears an accurate domain-specific meaning; I don't mind if it's --forge or --provider as per the poll above.

@dacbd
Copy link
Contributor

dacbd commented Sep 9, 2022

I disagree that this flag should be renamed.

As far as I read in your linked thread is about the wording in the description and docs, not the flag itself.

@casperdcl casperdcl added discussion Waiting for team decision ui/ux User interface/experience labels Oct 14, 2022
@0x2b3bfa0
Copy link
Member Author

After #1272, this issue is about choosing an adequate word to describe forges and using it to replace driver in both code and documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Waiting for team decision ui/ux User interface/experience
Projects
None yet
Development

No branches or pull requests

3 participants