From 62c48eff58d6dd4d2b0a817bbb36cd75087f0ae3 Mon Sep 17 00:00:00 2001 From: Michael Dilger Date: Fri, 16 Feb 2024 14:15:32 +1300 Subject: [PATCH] Breaking changes list (#1052) * Start of new BREAKING.md changes list * more * Make NIP column into links * notes * Make commits links * Remove optional P tag entry, was not breaking * Update BREAKING with nip-49 breaking change --- BREAKING.md | 21 +++++++++++++++++++++ README.md | 5 +++++ 2 files changed, 26 insertions(+) create mode 100644 BREAKING.md diff --git a/BREAKING.md b/BREAKING.md new file mode 100644 index 00000000..2a85a281 --- /dev/null +++ b/BREAKING.md @@ -0,0 +1,21 @@ +# Breaking Changes + +This is a history of NIP changes that potentially break pre-existing implementations, in +reverse chronological order. + +| Date | Commit | NIP | Change | +| ----------- | --------- | -------- | ------ | +| 2024-02-16 | [cbec02ab](https://github.com/nostr-protocol/nips/commit/cbec02ab) | [NIP-49](49.md) | Password first normalized to NFKC | +| 2024-02-15 | [afbb8dd0](https://github.com/nostr-protocol/nips/commit/afbb8dd0) | [NIP-39](39.md) | PGP identity was removed | +| 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [NIP-46](46.md) | Connection token format was changed | +| 2024-01-30 | [1a2b21b6](https://github.com/nostr-protocol/nips/commit/1a2b21b6) | [NIP-59](59.md) | 'p' tag became optional | +| 2023-01-27 | [c2f34817](https://github.com/nostr-protocol/nips/commit/c2f34817) | [NIP-47](47.md) | optional expiration tag should be honored | +| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [NIP-02](02.md) | list entries should be chronological | +| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [NIP-51](51.md) | list entries should be chronological | + +Breaking changes prior to 2024-01-01 are not yet documented. + +## NOTES + +- If it isn't clear that a change is breaking or not, we list it. +- The date is the date it was merged, not necessarily the date of the commit. diff --git a/README.md b/README.md index caecc016..b9ca8aa7 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [Criteria for acceptance of NIPs](#criteria-for-acceptance-of-nips) - [Is this repository a centralizing factor?](#is-this-repository-a-centralizing-factor) - [How this repository works](#how-this-repository-works) +- [Breaking Changes](#breaking-changes) - [License](#license) --- @@ -261,6 +262,10 @@ Standards may emerge in two ways: the first way is that someone starts doing som These two ways of standardizing things are supported by this repository. Although the second is preferred, an effort will be made to codify standards emerged outside this repository into NIPs that can be later referenced and easily understood and implemented by others -- but obviously as in any human system discretion may be applied when standards are considered harmful. +## Breaking Changes + +[Breaking Changes](BREAKING.md) + ## License All NIPs are public domain.