From 403bd46f0f5c6cd4533807b0d738d3ec777d5f51 Mon Sep 17 00:00:00 2001 From: Bob Jacobsen Date: Wed, 23 Apr 2025 10:12:36 -0400 Subject: [PATCH] add suggestions on what to consider during adoption --- DevelopmentAndAdoption.md | 12 ++++++++++++ README.md | 4 ++-- 2 files changed, 14 insertions(+), 2 deletions(-) create mode 100644 DevelopmentAndAdoption.md diff --git a/DevelopmentAndAdoption.md b/DevelopmentAndAdoption.md new file mode 100644 index 00000000..854e772c --- /dev/null +++ b/DevelopmentAndAdoption.md @@ -0,0 +1,12 @@ +Principles of Standards Development and Adoption + +This note lists some actions that should be considered as part of adopting a document from "Draft" to "Approved" status. + + - The [OlcbChecker](https://github.com/bobjacobsen/OlcbChecker) should include a test plan and checker code for the new or changed capability + - This should be made available early to node implementors so they can confirm coexistence of their products with any new or changed functionality + + - There should be at least two implementations that interoperate and pass the above checks + - ideally, these would have been developed independently + + - The updated document(s) should be posted to the [OpenLCB Group](https://groups.io/g/openlcb) and comments accepted for a week + - Those comments should be addressed on the group list, and if consensus exists, appropriate changes should be made diff --git a/README.md b/README.md index 82f0486a..24b24ec8 100644 --- a/README.md +++ b/README.md @@ -68,8 +68,8 @@ sudo apt-get install writer2latex links ## Process for adopting a document -The technical process for adopting a document is described in -[standards/Conventions.html](standards/Conventions.html). +Some consideration when deciding to adopt a document are described in +[DevelopmentAndAdoption.md](DevelopmentAndAdoption.md). ### Forking an adopted document to drafts