Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Myoldmopar committed Oct 23, 2015
1 parent 0301d94 commit 1a64de7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion design/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Welcome to Design Documents

This is where Design Documents live. Organization is a simple few rules:

- No files should be in here with the README unless they are super meta.
- The only files in here should be the README and the template. Nothing else unless it is super _meta_.
- The files should be organized into folders named FY20\*\*, where the \*\* is replaced with the fiscal year in which the design was first proposed for implementation. The actual year of implementation changes, so doing it off of that year would require more maintenance down the road.
- Design documents should be markdown, and named with just a short title of the feature: MyNewCoolModel.md
- Images should go right alongside the file, and named like: MyNewCoolModel-Figure01.png or similar. Try to make the images as compressed as possible to avoid bulking up the repo.
Expand Down

0 comments on commit 1a64de7

Please sign in to comment.