Adds design doc samples to encourage discussion from contributors pri…

…or to implementation
springfox · Apr 7, 2015 · 872a128 · 872a128
1 parent 647fc40
commit 872a128
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/design/sample-design-spec.md 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
@@ -0,0 +1,8 @@
+## A high-level design spec to detail how to generate asciidoc using swagger2asciidoc 
+
+### General Approach
+TBD
+
+### Test Coverage 
+TBD
+