Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 1.13 KB

review_guide.md

File metadata and controls

18 lines (14 loc) · 1.13 KB

Review Guide

We're looking to know

  • Is our charter targeting the right problems?
  • Do our goals represent a reasonable solution?
  • Are the scenarios we have listed sensible and reflective of the real world?
  • What other scenarios do you think are useful?
  • What do you think of the hypermedia aspects of this API and the use of HAL?
  • What do you think of our pagination scheme?
  • Please examine one or more scenarios and then evaluating the technical API details to mentally assess implementation. If possible, write a quick and dirty implementation against our prototype endpoint. From that experience we would like to know what challenges they foresee, any suggested changes to the API and what they like about it.
  • Please feel free to provide any other feedback.

Providing Feedback

The preferred way to provide feedback is to use the GitHub Issue feature. To submit a comment, please click the "Issues" link on the toolbar and then click "New Issue".

Fill out the issue with your comment and click "Submit"

If you are unable to do this, you may also email the reviewers list for discussion or privately to the editor: joshco@gmail.com