diff options
Diffstat (limited to 'API-BREAK.txt')
-rw-r--r-- | API-BREAK.txt | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/API-BREAK.txt b/API-BREAK.txt new file mode 100644 index 0000000..1785310 --- /dev/null +++ b/API-BREAK.txt @@ -0,0 +1,32 @@ +This file lists potential and planned API- +breaks. These are meant to be released +simultaneously to minimise the number of +extraneous and unnecessary breaks. + +When enough planned breaks are present, the +features are implemented and the major version +is incremented along with the minor and patch +versions being reset. + +Interfaces that are not public (those in the +impl, priv... namespaces) do NOT cause API- +breaks, as their use outside of the library is +both deprecated and causes UB (by our +definition). + + + +* Rename arch-macros to arc and impl to imp: +We usually use three-letter abbreviations, +however, other lengths are not prohibited. +Nevertheless, our coding style favours the +closest to three letters. Arc is already an +abbreviation for arch, so it doesn't seem too +far-fetched. The same goes for imp, and nobody +is (really) going to think we are dealing with +small numina. + +* Relicense project: +I'll have to research this a bit, but I'm not +sure if the MPL2 is permissive enough for my +needs. |