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

refactor(sdk): rename sdk package to api-client #314

Closed
petermetz opened this issue Oct 14, 2020 · 8 comments · Fixed by #324
Closed

refactor(sdk): rename sdk package to api-client #314

petermetz opened this issue Oct 14, 2020 · 8 comments · Fixed by #324
Labels
bug Something isn't working Developer_Experience documentation Improvements or additions to documentation enhancement New feature or request Hacktoberfest Hacktoberfest participants are welcome to take a stab at issues marked with this label.
Milestone

Comments

@petermetz
Copy link
Member

Description

As a developer I want to be able to quickly scan the packages available in the git repo so that I can get a better understanding of the architecture in a shorter time.

Currently we have a package named cactus-sdk which is probably ambiguous with the project itself which we sometimes refer to as an SDK of SDKs. That ambiguity could cause rational minds to question our terminology (yet again) since if the whole project is the SDK then why do we have 10+ packages and only one of them called SDK.
Based on all this that we should rename the package from @hyperledger/cactus-sdk to @hyperledger/cactus-api-client which much better describes (narrower scope) what that package actually does.

Acceptance Criteria

  1. In the package.json file, the properties: name, main, browser, browserMinified, mainMinified properties are all updated
  2. The references in all the other packages are also updated to import the new package instead of the old one (e.g. project must compile without issues
  3. Documentation is updated where necessary (the readme.md file of the package needs a looksie for sure)

cc: @RafaelAPB @sfuji822 @jonathan-m-hamilton @takeutak

@petermetz petermetz added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request Developer_Experience Hacktoberfest Hacktoberfest participants are welcome to take a stab at issues marked with this label. labels Oct 14, 2020
@petermetz petermetz added this to the v0.5.0 milestone Oct 14, 2020
@yash2189
Copy link
Contributor

Hello I'm new to opensource. I went through the packages file and was able to find the file package named cactus-sdk. Does that need to be renamed as cactus-api-client?

@petermetz
Copy link
Member Author

Hello I'm new to opensource. I went through the packages file and was able to find the file package named cactus-sdk. Does that need to be renamed as cactus-api-client?

@yash2189 Yes, among a few other things that's one of the items to take care of in the scope of this issue!
If you are also new to NodeJS, monorepos, Lerna, etc I recommend taking a look at these resources as well (will make much more sense after being familiar with the concepts):

https://docs.npmjs.com/packages-and-modules/
https://blog.npmjs.org/post/186494959890/monorepos-and-npm
https://github.com/lerna/lerna
Also potentially this if you are also new to Typescript: https://www.typescriptlang.org/

@yash2189
Copy link
Contributor

Thanks @petermetz yes I do not have much experience with typescript , Nodejs , lerna. I'll surely visit the resources provided.

@petermetz
Copy link
Member Author

Thanks @petermetz yes I do not have much experience with typescript , Nodejs , lerna. I'll surely visit the resources provided.

No worries @yash2189 another resource I can recommend is the local documentation in the CONTRIBUTING.md file and the BUILD.md file in this repo's root folder. Plenty of useful explanation in both of those if you are a new to some concepts. It will also help you ensure that if you do submit a pull request it will be one that is easier to review/accept/merge. Thank you in advance!

@yash2189
Copy link
Contributor

yash2189 commented Oct 17, 2020

@petermetz I had a look on the resources of npm that you provided.I have a question...After the package has been renamed do we have to run the npm command again in order to generate new files which would replace the old ones?

@petermetz
Copy link
Member Author

@petermetz I had a look on the resources of npm that you provided.I have a question...After the package has been renamed do we have to run the npm command again in order to generate new files which would replace the old ones?

@yash2189 Yes, that's necessary to make sure your contribution works as expected. Safest to run the full CI suite, but if you don't want to do that it's okay to let Travis CI do it once you support the PR.

@yash2189
Copy link
Contributor

@petermetz I have renamed the package and updated the required documentation. Raised a PR #314 for the same. Please review it.
Thanks.

petermetz added a commit to petermetz/cacti that referenced this issue Oct 26, 2020
This commit updates references of cactus-sdk that were missed by the earlier pull request:
hyperledger#324

Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>

hyperledger#314
petermetz added a commit that referenced this issue Oct 27, 2020
This commit updates references of cactus-sdk that were missed by the earlier pull request:
#324

Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>

#314
@petermetz
Copy link
Member Author

@petermetz I have renamed the package and updated the required documentation. Raised a PR #314 for the same. Please review it.
Thanks.

Great! Thank you so much @yash2189

@petermetz petermetz modified the milestones: v0.5.0, v0.2.0 Nov 3, 2020
ryjones pushed a commit that referenced this issue Feb 1, 2023
Feature to select Endorsing Orgs in Fabric Data Sharing
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working Developer_Experience documentation Improvements or additions to documentation enhancement New feature or request Hacktoberfest Hacktoberfest participants are welcome to take a stab at issues marked with this label.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants