Skip to content

Commit bf93d56

Browse files
committed
Add release schedule to README and site update
1 parent d022a74 commit bf93d56

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ Updated for 1.0 and later releases.
3838
- [JSON parser and emitter](#json-interchange)
3939
- [Error handling](#xchange-error-handling)
4040
- [Debugging support](#xchange-debugging-support)
41-
- [Future plans](#xchange-future-plans)
41+
- [Future plans](#xchange-future-plans)
42+
- [Release schedule](#xchange-release-schedule)
4243

4344

4445
-----------------------------------------------------------------------------
@@ -557,7 +558,7 @@ example,
557558
The JSON parser can also sink its error messages to a designated file or stream, which can be set by
558559
`xjsonSetErrorStream(FILE *)`.
559560
560-
-----------------------------------------------------------------------------
561+
-----------------------------------------------------------------------------
561562
562563
<a name="xchange-debugging-support"></a>
563564
## Debugging support
@@ -575,6 +576,7 @@ verbosity being enabled via `xSetVerbose(boolean)` and `xSetDebug(boolean)`, res
575576
__xchange__ may use these macros to produce their own verbose and/or debugging outputs conditional on the same global
576577
settings.
577578
579+
-----------------------------------------------------------------------------
578580
579581
<a name="xchange-future-plans"></a>
580582
## Future plans
@@ -589,6 +591,31 @@ paths forward are:
589591
If you have an idea for a must have feature, please let me (Attila) know. Pull requests, for new features or fixes to
590592
existing ones are especially welcome!
591593
594+
-----------------------------------------------------------------------------
595+
596+
<a name="xchange-release-schedule"></a>
597+
## Release schedule
598+
599+
A predictable release schedule and process can help manage expectations and reduce stress on adopters and developers
600+
alike.
601+
602+
The __xchange__ library will try to follow a quarterly release schedule. You may expect upcoming releases to be
603+
published around __February 1__, __May 1__, __August 1__, and/or __November 1__ each year, on an as-needed basis. That
604+
means that if there are outstanding bugs, or new pull requests (PRs), you may expect a release that addresses these in
605+
the upcoming quarter. The dates are placeholders only, with no guarantee that a new release will actually be available
606+
every quarter. If nothing of note comes up, a potential release date may pass without a release being published.
607+
608+
New features are generally reserved for the feature releases (e.g. __1.x.0__ version bumps), although they may also be
609+
rolled out in bug-fix releases as long as they do not affect the existing API -- in line with the desire to keep
610+
bug-fix releases fully backwards compatible with their parent versions.
611+
612+
In the weeks and month(s) preceding releases one or more _release candidates_ (e.g. `1.0.1-rc3`) will be published
613+
temporarily on GitHub, under [Releases](https://github.com/Smithsonian/xchange/releases), so that changes can be
614+
tested by adopters before the releases are finalized. Please use due diligence to test such release candidates with
615+
your code when they become available to avoid unexpected surprises when the finalized release is published. Release
616+
candidates are typically available for one week only before they are superseded either by another, or by the finalized
617+
release.
618+
592619
593620
-----------------------------------------------------------------------------
594621
Copyright (C) 2025 Attila Kovács

0 commit comments

Comments
 (0)