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

[Task] Scope npm package to @thenewboston/sdk #139

Open
denistsoi opened this issue Apr 10, 2021 · 8 comments
Open

[Task] Scope npm package to @thenewboston/sdk #139

denistsoi opened this issue Apr 10, 2021 · 8 comments
Assignees
Labels
help wanted Extra attention is needed Not Ready Task is not ready for development

Comments

@denistsoi
Copy link
Contributor

Task

Contributors are able to complete this task and earn thenewboston coins. Check out the labels to learn how much you can earn for contributing by completing this task. Please make sure to be honest if you wish to contribute by saying you can't finish this and we can just un-assign you with no harm done! There is no point in delaying tasks from being completed for miscommunication!

Overview

since there may be other npm packages by thenewboston org, it may be beneficial to scope this package with “@thenewboston”.

Behavior

Rename name in package.Json from “thenewboston” to “@thenewboston/sdk”

/* code examples are awesome */

Please ask for this task to be assigned to you and earn and its sweet reward 😉

Remember to include your account number in your PR description for us to pay you 💰

** Pull Requests **
All Pull Request should be made to development branch, read contributors guild for more information about contributing

@stweyel
Copy link

stweyel commented Apr 11, 2021

if that's just a renaming issue i could do that...

@zinoadidi zinoadidi added Not Ready Task is not ready for development help wanted Extra attention is needed labels Apr 12, 2021
@zinoadidi zinoadidi added this to New issues in thenewboston-js via automation Apr 12, 2021
@zinoadidi
Copy link
Contributor

@angle943 what do you think about the naming convention

@denistsoi
Copy link
Contributor Author

I'm just looking at how Sentry names its client side libraries (across different platforms).

https://docs.sentry.io/platforms/javascript/

  • React Native: @sentry/react-native,
  • Node: @sentry/node
  • Client: @sentry/browser

@angle943
Copy link
Contributor

angle943 commented Apr 22, 2021

@denistsoi @zinoadidi yeah i agree, we should rename this. tagging @buckyroberts

EDIT: i don't think it should be @thenewboston/sdk though, since we will have multiple sdk libraries. Perhaps @thenewboston/js, @thenewboston/js-sdk, or @thenewboston/sdk/js?

@denistsoi
Copy link
Contributor Author

Perhaps
@thenewboston/client/ @thenewboston/browser - that way you can separate between

npm supports TS/JS - however, i dont suspect us using something like WASM to be deployed via npm (tho a possibility)

@thenewboston/node
@thenewboston/ui

@tomijaga
Copy link
Contributor

I like @thenewboston/js-sdk

@zinoadidi
Copy link
Contributor

@buckyroberts awaiting input from you :)

@angle943
Copy link
Contributor

i'm down actually for @thenewboston/js-sdk

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed Not Ready Task is not ready for development
Projects
Development

No branches or pull requests

6 participants