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

Definition of "breaking change" #21

Open
greenled opened this issue Aug 10, 2019 · 1 comment
Open

Definition of "breaking change" #21

greenled opened this issue Aug 10, 2019 · 1 comment
Labels
help wanted Extra attention is needed question Further information is requested
Milestone

Comments

@greenled
Copy link
Owner

greenled commented Aug 10, 2019

A while ago this project adopted Semantic Versioning (#9) and so far there are two releases out following that specification 0.1.0 and 0.1.1. As new ones are on their way, there is a need for a clear definition of what is considered a "breaking change" and what is not.

From the spec:

Software using Semantic Versioning MUST declare a public API. This API could be declared in the code itself or exist strictly in documentation. However it is done, it SHOULD be precise and comprehensive.

So, what/where is this project's public API to start with?:

  • Executable's input/output format?
  • Docker image definition?
  • Settings?
  • Algorithms (and source code in general)?
  • Supported platforms?
  • External dependencies?
  • A mix of the above?

This issue is for addresing those questions. Findings should be added to the Readme.

@greenled
Copy link
Owner Author

The main use case of this tool is automating interaction with Portainer in a CI/CD pipeline (#18)

@greenled greenled pinned this issue Aug 10, 2019
@greenled greenled added help wanted Extra attention is needed question Further information is requested labels Aug 10, 2019
@greenled greenled added this to the 2.0 milestone Aug 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant