{"action":"created","comment":{"url":"https://api.github.com/repos/attic-labs/noms/pulls/comments/83275722","pull_request_review_id":4129389,"id":83275722,"diff_hunk":"@@ -21,6 +21,18 @@ Due to legal reasons, all contributors must sign a contributor agreement, either\n * Tag PRs with either `toward: #<bug>` or `fixes: #<bug>` to help establish context for why a change is happening\n * Commit messages follow [Chris Beam's awesome commit message style guide](http://chris.beams.io/posts/git-commit/)\n \n+### Go error reporting\n+\n+* For problems that are conceptually `asserts`, meaning that the program cannot meaningfully continue, use the following calls:\n+\t* d.Chk.Error()\n+\t* d.Chk.NoError()\n+\t* d.Chk.True()\n+\t* d.Chk.False()\n+* For problems that might occur during correct processing, you can choose the Go-style of returned errors, or use the following to 'raise' a 'catchable' error (see [go/d/try.go](https://godoc.org/github.com/attic-labs/noms/go/d)):\n+\t* d.PanicIfError()","path":"CONTRIBUTING.md","position":12,"original_position":12,"commit_id":"eb4395eb0b6df46b3b11855fd20d57ae54c2697e","original_commit_id":"eb4395eb0b6df46b3b11855fd20d57ae54c2697e","user":{"login":"willhite","id":487362,"avatar_url":"https://avatars.githubusercontent.com/u/487362?v=3","gravatar_id":"","url":"https://api.github.com/users/willhite","html_url":"https://github.com/willhite","followers_url":"https://api.github.com/users/willhite/followers","following_url":"https://api.github.com/users/willhite/following{/other_user}","gists_url":"https://api.github.com/users/willhite/gists{/gist_id}","starred_url":"https://api.github.com/users/willhite/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/willhite/subscriptions","organizations_url":"https://api.github.com/users/willhite/orgs","repos_url":"https://api.github.com/users/willhite/repos","events_url":"https://api.github.com/users/willhite/events{/privacy}","received_events_url":"https://api.github.com/users/willhite/received_events","type":"User","site_admin":false},"body":"You might want to add two additional points:\r\nIn general, for Public API in Noms, we use the Go-style of returned errors by default.\r\n* There must be an overriding rational for using the Exception-style. One reason to use the Exception style is that the current code doesn't know how to proceed and needs to panic, but we want to signal that a calling function somewhere up the stack might be able to recover from the panic and continue on.\r\n* Test code rarely, if ever, needs or should use these Exception-style functions ","created_at":"2016-10-13T18:01:26Z","updated_at":"2016-10-13T18:02:49Z","html_url":"https://github.com/attic-labs/noms/pull/2703#discussion_r83275722","pull_request_url":"https://api.github.com/repos/attic-labs/noms/pulls/2703","_links":{"self":{"href":"https://api.github.com/repos/attic-labs/noms/pulls/comments/83275722"},"html":{"href":"https://github.com/attic-labs/noms/pull/2703#discussion_r83275722"},"pull_request":{"href":"https://api.github.com/repos/attic-labs/noms/pulls/2703"}}},"pull_request":{"url":"https://api.github.com/repos/attic-labs/noms/pulls/2703","id":89240553,"html_url":"https://github.com/attic-labs/noms/pull/2703","diff_url":"https://github.com/attic-labs/noms/pull/2703.diff","patch_url":"https://github.com/attic-labs/noms/pull/2703.patch","issue_url":"https://api.github.com/repos/attic-labs/noms/issues/2703","number":2703,"state":"open","locked":false,"title":"Add some info about the  package to CONTRIBUTING.md","user":{"login":"cmasone-attic","id":13224090,"avatar_url":"https://avatars.githubusercontent.com/u/13224090?v=3","gravatar_id":"","url":"https://api.github.com/users/cmasone-attic","html_url":"https://github.com/cmasone-attic","followers_url":"https://api.github.com/users/cmasone-attic/followers","following_url":"https://api.github.com/users/cmasone-attic/following{/other_user}","gists_url":"https://api.github.com/users/cmasone-attic/gists{/gist_id}","starred_url":"https://api.github.com/users/cmasone-attic/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cmasone-attic/subscriptions","organizations_url":"https://api.github.com/users/cmasone-attic/orgs","repos_url":"https://api.github.com/users/cmasone-attic/repos","events_url":"https://api.github.com/users/cmasone-attic/events{/privacy}","received_events_url":"https://api.github.com/users/cmasone-attic/received_events","type":"User","site_admin":false},"body":"Discuss some guidelines for how we do Go error reporting\r\nin Noms code","created_at":"2016-10-13T16:49:32Z","updated_at":"2016-10-13T18:02:49Z","closed_at":null,"merged_at":null,"merge_commit_sha":"881e57e3a9090239f00a66addbf3588d4ac4f619","assignee":{"login":"willhite","id":487362,"avatar_url":"https://avatars.githubusercontent.com/u/487362?v=3","gravatar_id":"","url":"https://api.github.com/users/willhite","html_url":"https://github.com/willhite","followers_url":"https://api.github.com/users/willhite/followers","following_url":"https://api.github.com/users/willhite/following{/other_user}","gists_url":"https://api.github.com/users/willhite/gists{/gist_id}","starred_url":"https://api.github.com/users/willhite/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/willhite/subscriptions","organizations_url":"https://api.github.com/users/willhite/orgs","repos_url":"https://api.github.com/users/willhite/repos","events_url":"https://api.github.com/users/willhite/events{/privacy}","received_events_url":"https://api.github.com/users/willhite/received_events","type":"User","site_admin":false},"assignees":[{"login":"willhite","id":487362,"avatar_url":"https://avatars.githubusercontent.com/u/487362?v=3","gravatar_id":"","url":"https://api.github.com/users/willhite","html_url":"https://github.com/willhite","followers_url":"https://api.github.com/users/willhite/followers","following_url":"https://api.github.com/users/willhite/following{/other_user}","gists_url":"https://api.github.com/users/willhite/gists{/gist_id}","starred_url":"https://api.github.com/users/willhite/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/willhite/subscriptions","organizations_url":"https://api.github.com/users/willhite/orgs","repos_url":"https://api.github.com/users/willhite/repos","events_url":"https://api.github.com/users/willhite/events{/privacy}","received_events_url":"https://api.github.com/users/willhite/received_events","type":"User","site_admin":false}],"milestone":null,"commits_url":"https://api.github.com/repos/attic-labs/noms/pulls/2703/commits","review_comments_url":"https://api.github.com/repos/attic-labs/noms/pulls/2703/comments","review_comment_url":"https://api.github.com/repos/attic-labs/noms/pulls/comments{/number}","comments_url":"https://api.github.com/repos/attic-labs/noms/issues/2703/comments","statuses_url":"https://api.github.com/repos/attic-labs/noms/statuses/eb4395eb0b6df46b3b11855fd20d57ae54c2697e","head":{"label":"cmasone-attic:contrib","ref":"contrib","sha":"eb4395eb0b6df46b3b11855fd20d57ae54c2697e","user":{"login":"cmasone-attic","id":13224090,"avatar_url":"https://avatars.githubusercontent.com/u/13224090?v=3","gravatar_id":"","url":"https://api.github.com/users/cmasone-attic","html_url":"https://github.com/cmasone-attic","followers_url":"https://api.github.com/users/cmasone-attic/followers","following_url":"https://api.github.com/users/cmasone-attic/following{/other_user}","gists_url":"https://api.github.com/users/cmasone-attic/gists{/gist_id}","starred_url":"https://api.github.com/users/cmasone-attic/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cmasone-attic/subscriptions","organizations_url":"https://api.github.com/users/cmasone-attic/orgs","repos_url":"https://api.github.com/users/cmasone-attic/repos","events_url":"https://api.github.com/users/cmasone-attic/events{/privacy}","received_events_url":"https://api.github.com/users/cmasone-attic/received_events","type":"User","site_admin":false},"repo":{"id":64776588,"name":"noms","full_name":"cmasone-attic/noms","owner":{"login":"cmasone-attic","id":13224090,"avatar_url":"https://avatars.githubusercontent.com/u/13224090?v=3","gravatar_id":"","url":"https://api.github.com/users/cmasone-attic","html_url":"https://github.com/cmasone-attic","followers_url":"https://api.github.com/users/cmasone-attic/followers","following_url":"https://api.github.com/users/cmasone-attic/following{/other_user}","gists_url":"https://api.github.com/users/cmasone-attic/gists{/gist_id}","starred_url":"https://api.github.com/users/cmasone-attic/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cmasone-attic/subscriptions","organizations_url":"https://api.github.com/users/cmasone-attic/orgs","repos_url":"https://api.github.com/users/cmasone-attic/repos","events_url":"https://api.github.com/users/cmasone-attic/events{/privacy}","received_events_url":"https://api.github.com/users/cmasone-attic/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/cmasone-attic/noms","description":"The versioned, forkable, syncable database","fork":true,"url":"https://api.github.com/repos/cmasone-attic/noms","forks_url":"https://api.github.com/repos/cmasone-attic/noms/forks","keys_url":"https://api.github.com/repos/cmasone-attic/noms/keys{/key_id}","collaborators_url":"https://api.github.com/repos/cmasone-attic/noms/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/cmasone-attic/noms/teams","hooks_url":"https://api.github.com/repos/cmasone-attic/noms/hooks","issue_events_url":"https://api.github.com/repos/cmasone-attic/noms/issues/events{/number}","events_url":"https://api.github.com/repos/cmasone-attic/noms/events","assignees_url":"https://api.github.com/repos/cmasone-attic/noms/assignees{/user}","branches_url":"https://api.github.com/repos/cmasone-attic/noms/branches{/branch}","tags_url":"https://api.github.com/repos/cmasone-attic/noms/tags","blobs_url":"https://api.github.com/repos/cmasone-attic/noms/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/cmasone-attic/noms/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/cmasone-attic/noms/git/refs{/sha}","trees_url":"https://api.github.com/repos/cmasone-attic/noms/git/trees{/sha}","statuses_url":"https://api.github.com/repos/cmasone-attic/noms/statuses/{sha}","languages_url":"https://api.github.com/repos/cmasone-attic/noms/languages","stargazers_url":"https://api.github.com/repos/cmasone-attic/noms/stargazers","contributors_url":"https://api.github.com/repos/cmasone-attic/noms/contributors","subscribers_url":"https://api.github.com/repos/cmasone-attic/noms/subscribers","subscription_url":"https://api.github.com/repos/cmasone-attic/noms/subscription","commits_url":"https://api.github.com/repos/cmasone-attic/noms/commits{/sha}","git_commits_url":"https://api.github.com/repos/cmasone-attic/noms/git/commits{/sha}","comments_url":"https://api.github.com/repos/cmasone-attic/noms/comments{/number}","issue_comment_url":"https://api.github.com/repos/cmasone-attic/noms/issues/comments{/number}","contents_url":"https://api.github.com/repos/cmasone-attic/noms/contents/{+path}","compare_url":"https://api.github.com/repos/cmasone-attic/noms/compare/{base}...{head}","merges_url":"https://api.github.com/repos/cmasone-attic/noms/merges","archive_url":"https://api.github.com/repos/cmasone-attic/noms/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/cmasone-attic/noms/downloads","issues_url":"https://api.github.com/repos/cmasone-attic/noms/issues{/number}","pulls_url":"https://api.github.com/repos/cmasone-attic/noms/pulls{/number}","milestones_url":"https://api.github.com/repos/cmasone-attic/noms/milestones{/number}","notifications_url":"https://api.github.com/repos/cmasone-attic/noms/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/cmasone-attic/noms/labels{/name}","releases_url":"https://api.github.com/repos/cmasone-attic/noms/releases{/id}","deployments_url":"https://api.github.com/repos/cmasone-attic/noms/deployments","created_at":"2016-08-02T17:13:26Z","updated_at":"2016-08-02T17:13:27Z","pushed_at":"2016-10-13T16:48:53Z","git_url":"git://github.com/cmasone-attic/noms.git","ssh_url":"git@github.com:cmasone-attic/noms.git","clone_url":"https://github.com/cmasone-attic/noms.git","svn_url":"https://github.com/cmasone-attic/noms","homepage":"","size":25961,"stargazers_count":0,"watchers_count":0,"language":"Go","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"attic-labs:master","ref":"master","sha":"5619d2b3acc971b4df1e11e1888cfad0f0de9ced","user":{"login":"attic-labs","id":12534679,"avatar_url":"https://avatars.githubusercontent.com/u/12534679?v=3","gravatar_id":"","url":"https://api.github.com/users/attic-labs","html_url":"https://github.com/attic-labs","followers_url":"https://api.github.com/users/attic-labs/followers","following_url":"https://api.github.com/users/attic-labs/following{/other_user}","gists_url":"https://api.github.com/users/attic-labs/gists{/gist_id}","starred_url":"https://api.github.com/users/attic-labs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/attic-labs/subscriptions","organizations_url":"https://api.github.com/users/attic-labs/orgs","repos_url":"https://api.github.com/users/attic-labs/repos","events_url":"https://api.github.com/users/attic-labs/events{/privacy}","received_events_url":"https://api.github.com/users/attic-labs/received_events","type":"Organization","site_admin":false},"repo":{"id":36778364,"name":"noms","full_name":"attic-labs/noms","owner":{"login":"attic-labs","id":12534679,"avatar_url":"https://avatars.githubusercontent.com/u/12534679?v=3","gravatar_id":"","url":"https://api.github.com/users/attic-labs","html_url":"https://github.com/attic-labs","followers_url":"https://api.github.com/users/attic-labs/followers","following_url":"https://api.github.com/users/attic-labs/following{/other_user}","gists_url":"https://api.github.com/users/attic-labs/gists{/gist_id}","starred_url":"https://api.github.com/users/attic-labs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/attic-labs/subscriptions","organizations_url":"https://api.github.com/users/attic-labs/orgs","repos_url":"https://api.github.com/users/attic-labs/repos","events_url":"https://api.github.com/users/attic-labs/events{/privacy}","received_events_url":"https://api.github.com/users/attic-labs/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/attic-labs/noms","description":"The versioned, forkable, syncable database","fork":false,"url":"https://api.github.com/repos/attic-labs/noms","forks_url":"https://api.github.com/repos/attic-labs/noms/forks","keys_url":"https://api.github.com/repos/attic-labs/noms/keys{/key_id}","collaborators_url":"https://api.github.com/repos/attic-labs/noms/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/attic-labs/noms/teams","hooks_url":"https://api.github.com/repos/attic-labs/noms/hooks","issue_events_url":"https://api.github.com/repos/attic-labs/noms/issues/events{/number}","events_url":"https://api.github.com/repos/attic-labs/noms/events","assignees_url":"https://api.github.com/repos/attic-labs/noms/assignees{/user}","branches_url":"https://api.github.com/repos/attic-labs/noms/branches{/branch}","tags_url":"https://api.github.com/repos/attic-labs/noms/tags","blobs_url":"https://api.github.com/repos/attic-labs/noms/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/attic-labs/noms/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/attic-labs/noms/git/refs{/sha}","trees_url":"https://api.github.com/repos/attic-labs/noms/git/trees{/sha}","statuses_url":"https://api.github.com/repos/attic-labs/noms/statuses/{sha}","languages_url":"https://api.github.com/repos/attic-labs/noms/languages","stargazers_url":"https://api.github.com/repos/attic-labs/noms/stargazers","contributors_url":"https://api.github.com/repos/attic-labs/noms/contributors","subscribers_url":"https://api.github.com/repos/attic-labs/noms/subscribers","subscription_url":"https://api.github.com/repos/attic-labs/noms/subscription","commits_url":"https://api.github.com/repos/attic-labs/noms/commits{/sha}","git_commits_url":"https://api.github.com/repos/attic-labs/noms/git/commits{/sha}","comments_url":"https://api.github.com/repos/attic-labs/noms/comments{/number}","issue_comment_url":"https://api.github.com/repos/attic-labs/noms/issues/comments{/number}","contents_url":"https://api.github.com/repos/attic-labs/noms/contents/{+path}","compare_url":"https://api.github.com/repos/attic-labs/noms/compare/{base}...{head}","merges_url":"https://api.github.com/repos/attic-labs/noms/merges","archive_url":"https://api.github.com/repos/attic-labs/noms/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/attic-labs/noms/downloads","issues_url":"https://api.github.com/repos/attic-labs/noms/issues{/number}","pulls_url":"https://api.github.com/repos/attic-labs/noms/pulls{/number}","milestones_url":"https://api.github.com/repos/attic-labs/noms/milestones{/number}","notifications_url":"https://api.github.com/repos/attic-labs/noms/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/attic-labs/noms/labels{/name}","releases_url":"https://api.github.com/repos/attic-labs/noms/releases{/id}","deployments_url":"https://api.github.com/repos/attic-labs/noms/deployments","created_at":"2015-06-03T03:44:49Z","updated_at":"2016-10-13T18:01:52Z","pushed_at":"2016-10-13T17:08:58Z","git_url":"git://github.com/attic-labs/noms.git","ssh_url":"git@github.com:attic-labs/noms.git","clone_url":"https://github.com/attic-labs/noms.git","svn_url":"https://github.com/attic-labs/noms","homepage":"","size":38397,"stargazers_count":4326,"watchers_count":4326,"language":"Go","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":112,"mirror_url":null,"open_issues_count":231,"forks":112,"open_issues":231,"watchers":4326,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/attic-labs/noms/pulls/2703"},"html":{"href":"https://github.com/attic-labs/noms/pull/2703"},"issue":{"href":"https://api.github.com/repos/attic-labs/noms/issues/2703"},"comments":{"href":"https://api.github.com/repos/attic-labs/noms/issues/2703/comments"},"review_comments":{"href":"https://api.github.com/repos/attic-labs/noms/pulls/2703/comments"},"review_comment":{"href":"https://api.github.com/repos/attic-labs/noms/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/attic-labs/noms/pulls/2703/commits"},"statuses":{"href":"https://api.github.com/repos/attic-labs/noms/statuses/eb4395eb0b6df46b3b11855fd20d57ae54c2697e"}}}}
{"actor":{"display_login":"willhite"}}