thenewboston-blockchain/thenewboston-js

[Task] Scope npm package to @thenewboston/sdk

Opened this issue · 8 comments

denistsoi commented

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 commented

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

zinoadidi commented

@angle943 what do you think about the naming convention

denistsoi commented

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 commented

@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 commented

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 commented

I like @thenewboston/js-sdk

zinoadidi commented

@buckyroberts awaiting input from you :)

angle943 commented

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

  • ❤️1