Skip to content

Commit c144871

Browse files
committed
Create a directory for specifications
1 parent 8f9f1fb commit c144871

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

docs-internal/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
# Internal Documents and Specifications
3+
4+
This directory contains internal documents and specifications. These
5+
fall into a number of categories:
6+
7+
* Guidelines and best practices
8+
* Design documents
9+
* Feature proposals
10+
* Or pretty much anything else
11+
12+
By keeping our documents as source code we can easily find them and easily review them.
13+
14+
# Specs vs GitHub Issues
15+
16+
In many cases GitHub issues are sufficient for tracking requirements and basic
17+
proposals. But a spec might be more appropriate if you want an easy to review,
18+
living document with a fair amount of detail.
19+
20+
# Use Markdown
21+
22+
Write your specs in Markdown. AsciiDoc is also OK if you need it.
23+

0 commit comments

Comments
 (0)