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

feature: unify how properties are defined (under_score to camelCase) #173

Open
elboletaire opened this issue May 16, 2023 · 0 comments
Open
Assignees
Labels
enhancement New feature or request

Comments

@elboletaire
Copy link
Member

elboletaire commented May 16, 2023

Describe the feature

The SDK uses under_scored and camelCased properties in objects without an apparent differentiation between them.

Motivation

To have a logical API, which is easy to follow and is congruent with all its definitions.

Proposal

Redefine all public under_scored properties to camelCased ones.

Components affected

  • ClientOptions
  • VocdoniSDKClient

And probably more, in general we should check every exposed object that is not a mapping interface/class (obviously those used for mapping may require underscore in some fields, but these usually are not publicly exposed to the developers [yes, they are exposed, but not "publicly"..]).

Constraints & Assumptions

This is a breaking change, so we may need to release a new major beta version (i.e. 0.2.0)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants