{"action":"closed","issue":{"url":"https://api.github.com/repos/chrisbrineweb/Jamming---Feature-Request/issues/3","repository_url":"https://api.github.com/repos/chrisbrineweb/Jamming---Feature-Request","labels_url":"https://api.github.com/repos/chrisbrineweb/Jamming---Feature-Request/issues/3/labels{/name}","comments_url":"https://api.github.com/repos/chrisbrineweb/Jamming---Feature-Request/issues/3/comments","events_url":"https://api.github.com/repos/chrisbrineweb/Jamming---Feature-Request/issues/3/events","html_url":"https://github.com/chrisbrineweb/Jamming---Feature-Request/issues/3","id":346440488,"node_id":"MDU6SXNzdWUzNDY0NDA0ODg=","number":3,"title":"Caveats Section","user":{"login":"jordanwillis","id":7652259,"node_id":"MDQ6VXNlcjc2NTIyNTk=","avatar_url":"https://avatars2.githubusercontent.com/u/7652259?v=4","gravatar_id":"","url":"https://api.github.com/users/jordanwillis","html_url":"https://github.com/jordanwillis","followers_url":"https://api.github.com/users/jordanwillis/followers","following_url":"https://api.github.com/users/jordanwillis/following{/other_user}","gists_url":"https://api.github.com/users/jordanwillis/gists{/gist_id}","starred_url":"https://api.github.com/users/jordanwillis/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jordanwillis/subscriptions","organizations_url":"https://api.github.com/users/jordanwillis/orgs","repos_url":"https://api.github.com/users/jordanwillis/repos","events_url":"https://api.github.com/users/jordanwillis/events{/privacy}","received_events_url":"https://api.github.com/users/jordanwillis/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-08-01T04:05:54Z","updated_at":"2018-08-01T13:41:02Z","closed_at":"2018-08-01T13:41:02Z","author_association":"NONE","body":"After reading through your Caveats Section, I feel like this is the extra detail that I mentioned in my Technical Design Section feedback and belongs up in that section since it expands upon how the feature will be implemented.\r\n\r\nThe Caveat Section is really intended to contain any information about other alternative solutions and the potential trade-offs/drawbacks between the selected solution and these alternates.  Once the trade-offs are understand then you can better justify why the approach described in the Technical Design section was selected as the best solution. \r\n\r\nThis gives the readers (again who will be business stakeholders, architects, tech leads, etc.) the ability to better understand your rational and provide extra input on whether your proposed solution will be the best fit for the application as whole."}}
{"actor":{"display_login":"chrisbrineweb"}}