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 install to upload; alias as install #1621

Open
chadoh opened this issue Sep 24, 2024 · 3 comments
Open

rename install to upload; alias as install #1621

chadoh opened this issue Sep 24, 2024 · 3 comments

Comments

@chadoh
Copy link
Contributor

chadoh commented Sep 24, 2024

In the XDR & SDK, the operation is called upload.

"Upload" makes more sense with most people's mental model, too. From the perspective of the person issuing the command, they are uploading something to the blockchain. Only from the perspective of the blockchain itself does it make sense to think of it as an "upload."

Let's rename the command. To avoid breaking the numerous scripts and docs that refer to the old name, let's alias it with the old install name. We can keep the alias around indefinitely.

@github-project-automation github-project-automation bot moved this to Backlog (Not Ready) in DevX Sep 24, 2024
@chadoh chadoh moved this from Backlog (Not Ready) to Todo (Ready for Dev) in DevX Sep 24, 2024
@leighmcculloch
Copy link
Member

💯 The big reason to do this rename is that "upload" is what the protocol ended up calling it, and the cli never caught up and updated to the same vocab.

@PoulavBhowmick03
Copy link

I would like to work on this
I'm Poulav Bhowmick, a software engineer at Invisible Studios with a robust background in TypeScript, Rust, Solidity Cairo, fullstack development and blockchain technology. My experience includes building robust applications, optimizing functionalities and blockchain integration. I have actively participated in events and open source contributions, enhancing my capability to tackle real-world tech challenges. My projects can be viewed on my GitHub Profile and OnlyDust Profile. Plus I´m active member of Starknet, Ethereum ecosystem.

I will approach this task of renaming install to upload while preserving backwards compatibility by following these steps:

Rename the Command:

I will modify the existing codebase to rename the command install to upload wherever it appears in the XDR & SDK, ensuring the terminology is consistent with the notion of uploading to the blockchain.
This will involve updating function names, comments, and any UI labels or messages that refer to the operation as "install."
Alias the Old Command:

To maintain backwards compatibility, I will create an alias for the old install command that maps to upload. This way, any existing scripts or documentation referring to install will continue to function without issues.
I will ensure this alias is available indefinitely, providing a smooth transition for users who are accustomed to the old command.
Update Documentation:

I will update the relevant documentation to reflect the change from install to upload. The documentation will note that install is now an alias for upload to avoid confusion for new users.
I will also perform a search through the codebase to ensure that any references to the install command in comments, guides, or external documentation are updated accordingly.
Testing:

After making these changes, I will test both the upload command and the install alias to ensure that both function correctly and produce the same results.
I will also run any existing unit or integration tests to confirm that the alias doesn't introduce any unexpected issues.

ETA - 3 days

Copy link

onlydustapp bot commented Sep 26, 2024

Hey @PoulavBhowmick03!
Thanks for showing interest.
We've created an application for you to contribute to Stellar CLI.
Go check it out on OnlyDust!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo (Ready for Dev)
Development

No branches or pull requests

3 participants