search

ericsomdahl / python-bittrex

Python bindings for bittrex
MIT License
585 stars 283 forks source link

Rename get_marketsummary to get_market_summary #134

Closed vyttieri closed 6 years ago

vyttieri commented 6 years ago
vyttieri commented 6 years ago

@ericsomdahl This is a breaking change, so might warrant a major version bump? Let me know if you'd like me to change that in the codebase... 0.2.2 > 1.0.0 in setup.py?

ericsomdahl commented 6 years ago

@codesw1tch i don't think we'll ever get to 1.0 😃 Maybe when the websocket code finally lands.

Bumping to 0.3.0 will be perfect for this.

vyttieri commented 6 years ago

@ericsomdahl Makes sense :) wasn't sure if you were using semantic versioning on the project. Bumped to 0.3.0!

skyl commented 6 years ago

Breaking changes are allowed in semantic versioning during 0.X 😉

vyttieri commented 6 years ago

@skyl

https://semver.org/

MAJOR version when you make incompatible API changes, MINOR version when you add functionality in a backwards-compatible manner, and PATCH version when you make backwards-compatible bug fixes.

I'd argue that it should be a MAJOR bump since it's an incompatible API change!

edit: I see you're referring to

How should I deal with revisions in the 0.y.z initial development phase? The simplest thing to do is start your initial development release at 0.1.0 and then increment the minor version for each subsequent release.

Makes sense! 👍