Skip to content

Commit

Permalink
docs: document why a stable release (1.0.0) is being made
Browse files Browse the repository at this point in the history
  • Loading branch information
barona-mika-vilpas committed Jan 15, 2024
1 parent 2ae574a commit 120fe7c
Showing 1 changed file with 27 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Release stable version

Date: 2024-01-15

## Context

The project version has been on `0.x.x` since its inception. However, the semver.org website states that the major version `0` is intended for "rapid development and fast iteration" only:

> https://semver.org/#how-do-i-know-when-to-release-100
>
> How do I know when to release 1.0.0?
>
> If your software is being used in production, it should probably already be 1.0.0. If you have a stable API on which users have come to depend, you should be 1.0.0. If you’re worrying a lot about backward compatibility, you should probably already be 1.0.0.
This is important because many tools for automatic dependency updates, such as dependabot or renovate, are typically configured to not automatically upgrade major version changes (they should be handled manually instead).

## Decision

We will release version `1.0.0` of the project.

From this point on, we will follow semantic versioning.

## Expected consequences

Users of the project will be able to use automatic dependency updates for the project.

Releasing breaking changes will not cause issues for users who are using automatic dependency updates.

0 comments on commit 120fe7c

Please sign in to comment.