From 872a128ec614c7543e61d59d74fcbff1316405db Mon Sep 17 00:00:00 2001 From: Adrian Kelly Date: Tue, 7 Apr 2015 23:30:38 +1000 Subject: [PATCH] Adds design doc samples to encourage discussion from contributors prior to implementation --- design/sample-design-spec.md | 10 ++++++++++ design/swagger2asciidoc-integration.md | 8 ++++++++ 2 files changed, 18 insertions(+) create mode 100644 design/sample-design-spec.md create mode 100644 design/swagger2asciidoc-integration.md diff --git a/design/sample-design-spec.md b/design/sample-design-spec.md new file mode 100644 index 00000000000..fc50608d227 --- /dev/null +++ b/design/sample-design-spec.md @@ -0,0 +1,10 @@ +## A spec to detail ... +Briefly, what is being proposed/implemented. + +### General Approach +- How will the feature be implemented, at a high-level? + - What modules will the changes impact? + - Will there be any public api changes? + +### Test Coverage +- Unit, integration, any special edge cases? diff --git a/design/swagger2asciidoc-integration.md b/design/swagger2asciidoc-integration.md new file mode 100644 index 00000000000..cb0f957b88f --- /dev/null +++ b/design/swagger2asciidoc-integration.md @@ -0,0 +1,8 @@ +## A high-level design spec to detail how to generate asciidoc using swagger2asciidoc + +### General Approach +TBD + +### Test Coverage +TBD +