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

Introduce semantic versioning for APIB #14

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

kylef
Copy link
Member

@kylef kylef commented Feb 9, 2016

This RFC proposes that the API Blueprint language and specification are versioned via Semantic Versioning, and there is a CHANGELOG file including a list of changes for each release.

## Backwards Compatibility

This is entirely backwards compatible, since the previous released versions are
the same and this only affects upcoming versions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

previous released versions are the same

What do you mean by this sentence?

@pksunkara
Copy link
Contributor

I am okay with this, but I wonder about backward compatibility. Also, there are a few things that need to be finalised. Like:

  • Will we support multiple versions of APIB? Or is it always going to be the latest version?
  • APIB is pretty stable, so I don't know if we really need the major and minor numbers from semantic versioning.

This sounds like a good idea, but "if it ain't broke don't fix it"

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