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

Thoughts on implementing semantic versioning #112

Closed
krissalvador27 opened this issue Aug 31, 2018 · 2 comments
Closed

Thoughts on implementing semantic versioning #112

krissalvador27 opened this issue Aug 31, 2018 · 2 comments

Comments

@krissalvador27
Copy link
Contributor

Hello!

Reactochart doesn't have any official release & versioning procedures and I wanted to propose the official adoption of semantic versioning going forward. Per semver this would mean

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

Goals

  • Provide Reactochart users with a more meaningful idea of what each version upgrade entails. Major version upgrades relate to breaking API changes. Minor version upgrades relate to newly added or updated API changes with backward compatibility. Patch versions are for bugs and refactors that don't affect the API.
  • Removes subjectivity and human emotion from versioning through rules that are easy to reason with

What this doesn't solve

  • Documentation: Reactochart is for developers (not machines) and as maintainers we are responsible for documenting the changes of each release. This means being descriptive with our changes via the changelog, and updating our docs on gh-pages with each release.
@krissalvador27
Copy link
Contributor Author

closing issue - we're going to go with this approach :)

@dandelany
Copy link
Contributor

Belated 👍 👍 from me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants