leopardslab / leopardslab/nodecloud
Refactoring the index.js file of AWS and GCP plugin by renaming the parameter
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 95
- Forks
- 87
- PR merge metrics
- No merged PRs in 30d
Description
We are passing in the configuration details to the plugin from the ncConfig file via the common package
https://github.com/leopardslab/nodecloud/blob/c8597192259598cbb90261b75ccb8aaf209deb78/packages/common/core/base-provider.js#L58
here the parameter for taking the configuration details from the ncConfig file is named options.
https://github.com/leopardslab/nodecloud/blob/c8597192259598cbb90261b75ccb8aaf209deb78/packages/aws-plugin/index.js#L4
Similarly, the GCP plugin is also taking in the configuration details as a parameter named options.
https://github.com/leopardslab/nodecloud/blob/c8597192259598cbb90261b75ccb8aaf209deb78/packages/gcp-plugin/index.js#L13
It would be easy to understand if we rename the options as configuration details
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with packages/common/core/base-provider.js at line 58, then compare the parameter declarations in packages/aws-plugin/index.js and packages/gcp-plugin/index.js. Confirm the configuration argument is named consistently in both plugins and that the refactor leaves their behavior unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, gcp, javascript
- Domain
- cloud
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100