Skip to content

Commit

Permalink
add stability promise
Browse files Browse the repository at this point in the history
  • Loading branch information
tomeichlersmith committed Aug 30, 2024
1 parent d5a2050 commit 3cf7b95
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
- [Introduction](./README.md)
- [Motivation](./background/motivation.md)
- [Vocabulary](./background/vocab.md)
- [Stability Promise](./background/stability-promise.md)
- [Getting Started](./getting_started.md)
- [Sidebar on Operating Systems](./os-sidebar.md)
- [Tuning the denv](./tune.md)
- [Command Reference Manual](./manual.md)
- [denv](./manual/denv.md)
Expand Down
20 changes: 20 additions & 0 deletions docs/src/background/stability-promise.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Stability Promise

With the release of version 1.0, denv features a strong
commitment to backwards compatibility and stability.

Future releases will not introduce backwards incompatible changes
that make existing denv configurations (mostly represented by the `.denv/config`
file whose specification is [in the manual](../manual/denv-config.md#files))
stop working, or break working invocations of the command-line interface.

This does not, however, preclude fixing outright bugs, even if doing so might
break denv configurations that rely on their behavior.

There will never be a denv 2.0.
Any desirable backwards-incompatible changes will be opt-in on a per-denv basis,
so users may migrate at their leisure.

---
Stability promise text copied heavily from
[just](https://just.systems/man/en/chapter_9.html).

0 comments on commit 3cf7b95

Please sign in to comment.