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

Semantic versioning #122

Merged
merged 14 commits into from
Dec 15, 2023
Merged

Semantic versioning #122

merged 14 commits into from
Dec 15, 2023

Conversation

enzbus
Copy link
Collaborator

@enzbus enzbus commented Dec 13, 2023

Declare support for semantic versioning in Cvxportfolio since version 1.0.0:

https://semver.org/

Maintain a TODOs file with planned changes and which next releases are targeted:

  • major release (> 1 yr), possibly breaking changes
  • minor release (<= 1yr), new features
  • revision or patch (~ 1 mo), bug fixes

Headroom for breaking changes: public API vs private API. Case-by-case basis (e.g., making a private method public is not a breaking change; adding an argument with default value to a public method is not, ...).

Bugs are defined as deviations b/w code and paper or code and documentation. Improving the docs or adding examples count as bug fix.

@coveralls
Copy link

coveralls commented Dec 13, 2023

Coverage Status

coverage: 98.962%. remained the same
when pulling 66e7df2 on semantic_versioning
into b7e3516 on master.

@enzbus enzbus merged commit 23ababb into master Dec 15, 2023
8 of 16 checks passed
@enzbus enzbus deleted the semantic_versioning branch July 13, 2024 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants