diff options
| author | Daniel Silverstone <dsilvers+gitlab@digital-scurf.org> | 2023-08-27 10:00:08 +0000 |
|---|---|---|
| committer | Lars Wirzenius <liw@liw.fi> | 2023-08-27 10:00:08 +0000 |
| commit | dc646ac1089be4590d9577ffe823a1198e387d6c (patch) | |
| tree | 15c421995652198c961aa5de70ac027332f55ae1 /DECISIONS.md | |
| parent | e88615a17d72eb1244093e58c52cd724f1b59839 (diff) | |
| download | subplot-dc646ac1089be4590d9577ffe823a1198e387d6c.tar.gz | |
docs: review changes from Daniel
Diffstat (limited to 'DECISIONS.md')
| -rw-r--r-- | DECISIONS.md | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/DECISIONS.md b/DECISIONS.md index 5d67d4e..4780b5e 100644 --- a/DECISIONS.md +++ b/DECISIONS.md @@ -29,9 +29,9 @@ Who: Daniel, Lars Details: Our main guideline should be that if an existing, working subplot document or the code generated from it stops working after a change, it was a breaking change. However, the stricter we are about -this, the harder it will be for us to make any changes, and thus I +this, the harder it will be for us to make any changes, and thus we think we should, at least in this stage of Subplot's development, be -more relaxed. I propose we keep two lists of criteria: one for things +more relaxed. We propose we keep two lists of criteria: one for things we do consider to be breaking changes, and we don't. We should consider changes from release to release, not just per @@ -50,7 +50,7 @@ We need to consider: Rust code for the step implementations, and the "context" used or modified by step implementations -For the "yes, these can be breaking changes": +For the "yes, these are likely to be breaking changes": * Dropping or renaming, the name of the Subplot binary. * Dropping or renaming a command line option or subcommand, or the @@ -59,7 +59,7 @@ For the "yes, these can be breaking changes": * Changing Subplot so that users would have to upgrade both `subplotlib` and `subplot-build` at the same time. * Dropping or changing the meaning of a YAML metadata or bindings file - key. Adding keys is not a breaking change. + key. Adding keys is not a breaking change (see below). * Dropping support for or changing the meaning of a markdown feature. * Dropping or renaming a step library. * Dropping an implementation language for a step library. @@ -70,6 +70,8 @@ For the "yes, these can be breaking changes": changes behavior in an unwanted way. * Changing the output of `docgen` in a way that affects the meaning of the document. +* Changing or removing any exported part of a `subplotlib` context object, + or any of the documented portions of the Python or Bash contexts. For the "sorry, these aren't breaking changes": |