Initial Draft of API Standards

grasmash commented 11 years ago

This is a first draft of the WhiteHouse API Standards. I've set up the basic directory structure for future development, and created a few placeholder files that will be drafted at a later time.

bryanhirsch commented 11 years ago

I think this looks really good Matt. I posted a few comments above with suggestions for a few minor edits.

A few general comments:

I think we should probably rename API.md README.md, just because READMEs show up by default like a project's homepage on GitHub. Since we separated this repo out from the api_interface module, API.md is really the main event. Might as well make it the README, right?
Are you familiar with git rebase -i <commit-id> ? If not, let's hop on Skype and do it together. I think it would be really easy to tidy up this commit history. Makes reviews easier to do and logs easier to read and more meaningful in the future.

grasmash commented 11 years ago

I've made the changes that you suggested and rebased the branch to squash all of my changes into one commit.

bryanhirsch commented 11 years ago

Committed. Closing.

https://github.com/WhiteHouse/api-standards/commit/9d434ef4f240d2ea8f62307e81c2bb6ded165458

WhiteHouse / api-standards

Initial Draft of API Standards #1