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
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions draft/semantic-versioning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
RFC: XXXX
Author: Kyle Fuller
Status: Draft
Created: 2015-02-04
Last Modified: 2015-02-04
---

# API Blueprint RFC XXXX: Semantic Versioning

## Table of Contents

- [Abstract](#abstract)
- [Motivation](#motivation)
- [Rationale](#rationale)
- [Backwards Compatibility](#backwards-compatibility)

## Abstract

This RFC proposes that the API Blueprint language and specification are
versioned via [Semantic Versioning](http://semver.org), and there is a
[CHANGELOG](https://github.com/kylef/changelog) file including a list of
changes for each release.

## Motivation

Currently API Blueprint uses a non-standard version format such as `1A9` which
is vastly different from version numbers elsewhere. The benefits of semantic
versioning is that anyone can understand the types of changes in major, minor
or patch releases, while that isn't possible using our current release
versioning.

Semantic versioning would bring API Blueprint's versioning to the same format
as used by the wide range of tooling and parsers for API Blueprint.

## 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?