{"action":"created","comment":{"url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/pulls/comments/80719905","pull_request_review_id":1754657,"id":80719905,"diff_hunk":"@@ -59,6 +59,88 @@ style guide that you will not find in the GitHub one.\n \n ## Standards ##\n \n+### Naming Convention ###\n+\n+With Swift 3, Apple updated the Swift [API design guidelines](https://swift.org/documentation/api-design-guidelines/) to promote clarity over brevity.\n+\n+Capitalize all type names with camel case, while function and variable names start with a lower case. Avoid acronyms and abbreviations for clarity and readability.\n+\n+#### Protocols ####\n+\n+Protocols describing something should be a noun: `Collection`, `Element`. Protocols describing an ability should end with “ing” or “able”: `Evaluatable`, `Printable`, `Formatting`.\n+\n+#### Enum ####\n+\n+Enum cases should start with a lower case and be camel case.","path":"README.md","position":16,"original_position":16,"commit_id":"a5590b4b57ff89c74e014970af5a3186772a2bb2","original_commit_id":"a5590b4b57ff89c74e014970af5a3186772a2bb2","user":{"login":"paulmiard","id":1609966,"avatar_url":"https://avatars.githubusercontent.com/u/1609966?v=3","gravatar_id":"","url":"https://api.github.com/users/paulmiard","html_url":"https://github.com/paulmiard","followers_url":"https://api.github.com/users/paulmiard/followers","following_url":"https://api.github.com/users/paulmiard/following{/other_user}","gists_url":"https://api.github.com/users/paulmiard/gists{/gist_id}","starred_url":"https://api.github.com/users/paulmiard/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/paulmiard/subscriptions","organizations_url":"https://api.github.com/users/paulmiard/orgs","repos_url":"https://api.github.com/users/paulmiard/repos","events_url":"https://api.github.com/users/paulmiard/events{/privacy}","received_events_url":"https://api.github.com/users/paulmiard/received_events","type":"User","site_admin":false},"body":"start with a lowercase letter and use camelCase\r\n\r\nOR\r\n\r\nstart with a lower case letter and use camel case\r\n","created_at":"2016-09-27T15:25:49Z","updated_at":"2016-09-27T15:25:49Z","html_url":"https://github.com/prolificinteractive/swift-style-guide/pull/45#discussion_r80719905","pull_request_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/pulls/45","_links":{"self":{"href":"https://api.github.com/repos/prolificinteractive/swift-style-guide/pulls/comments/80719905"},"html":{"href":"https://github.com/prolificinteractive/swift-style-guide/pull/45#discussion_r80719905"},"pull_request":{"href":"https://api.github.com/repos/prolificinteractive/swift-style-guide/pulls/45"}}},"pull_request":{"url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/pulls/45","id":86892393,"html_url":"https://github.com/prolificinteractive/swift-style-guide/pull/45","diff_url":"https://github.com/prolificinteractive/swift-style-guide/pull/45.diff","patch_url":"https://github.com/prolificinteractive/swift-style-guide/pull/45.patch","issue_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/issues/45","number":45,"state":"open","locked":false,"title":"Added naming convention section to the README","user":{"login":"ThibaultKlein","id":6641355,"avatar_url":"https://avatars.githubusercontent.com/u/6641355?v=3","gravatar_id":"","url":"https://api.github.com/users/ThibaultKlein","html_url":"https://github.com/ThibaultKlein","followers_url":"https://api.github.com/users/ThibaultKlein/followers","following_url":"https://api.github.com/users/ThibaultKlein/following{/other_user}","gists_url":"https://api.github.com/users/ThibaultKlein/gists{/gist_id}","starred_url":"https://api.github.com/users/ThibaultKlein/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ThibaultKlein/subscriptions","organizations_url":"https://api.github.com/users/ThibaultKlein/orgs","repos_url":"https://api.github.com/users/ThibaultKlein/repos","events_url":"https://api.github.com/users/ThibaultKlein/events{/privacy}","received_events_url":"https://api.github.com/users/ThibaultKlein/received_events","type":"User","site_admin":false},"body":"","created_at":"2016-09-27T09:27:42Z","updated_at":"2016-09-27T15:52:14Z","closed_at":null,"merged_at":null,"merge_commit_sha":"cdc52fd90cd0803d08f75d0d212a53874ee1a694","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/pulls/45/commits","review_comments_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/pulls/45/comments","review_comment_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/pulls/comments{/number}","comments_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/issues/45/comments","statuses_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/statuses/a5590b4b57ff89c74e014970af5a3186772a2bb2","head":{"label":"prolificinteractive:swift-3-naming-convention","ref":"swift-3-naming-convention","sha":"a5590b4b57ff89c74e014970af5a3186772a2bb2","user":{"login":"prolificinteractive","id":1280427,"avatar_url":"https://avatars.githubusercontent.com/u/1280427?v=3","gravatar_id":"","url":"https://api.github.com/users/prolificinteractive","html_url":"https://github.com/prolificinteractive","followers_url":"https://api.github.com/users/prolificinteractive/followers","following_url":"https://api.github.com/users/prolificinteractive/following{/other_user}","gists_url":"https://api.github.com/users/prolificinteractive/gists{/gist_id}","starred_url":"https://api.github.com/users/prolificinteractive/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/prolificinteractive/subscriptions","organizations_url":"https://api.github.com/users/prolificinteractive/orgs","repos_url":"https://api.github.com/users/prolificinteractive/repos","events_url":"https://api.github.com/users/prolificinteractive/events{/privacy}","received_events_url":"https://api.github.com/users/prolificinteractive/received_events","type":"Organization","site_admin":false},"repo":{"id":44618802,"name":"swift-style-guide","full_name":"prolificinteractive/swift-style-guide","owner":{"login":"prolificinteractive","id":1280427,"avatar_url":"https://avatars.githubusercontent.com/u/1280427?v=3","gravatar_id":"","url":"https://api.github.com/users/prolificinteractive","html_url":"https://github.com/prolificinteractive","followers_url":"https://api.github.com/users/prolificinteractive/followers","following_url":"https://api.github.com/users/prolificinteractive/following{/other_user}","gists_url":"https://api.github.com/users/prolificinteractive/gists{/gist_id}","starred_url":"https://api.github.com/users/prolificinteractive/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/prolificinteractive/subscriptions","organizations_url":"https://api.github.com/users/prolificinteractive/orgs","repos_url":"https://api.github.com/users/prolificinteractive/repos","events_url":"https://api.github.com/users/prolificinteractive/events{/privacy}","received_events_url":"https://api.github.com/users/prolificinteractive/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/prolificinteractive/swift-style-guide","description":"A style guide for Swift.","fork":false,"url":"https://api.github.com/repos/prolificinteractive/swift-style-guide","forks_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/forks","keys_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/keys{/key_id}","collaborators_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/teams","hooks_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/hooks","issue_events_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/issues/events{/number}","events_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/events","assignees_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/assignees{/user}","branches_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/branches{/branch}","tags_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/tags","blobs_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/git/refs{/sha}","trees_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/git/trees{/sha}","statuses_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/statuses/{sha}","languages_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/languages","stargazers_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/stargazers","contributors_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/contributors","subscribers_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/subscribers","subscription_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/subscription","commits_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/commits{/sha}","git_commits_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/git/commits{/sha}","comments_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/comments{/number}","issue_comment_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/issues/comments{/number}","contents_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/contents/{+path}","compare_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/compare/{base}...{head}","merges_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/merges","archive_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/downloads","issues_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/issues{/number}","pulls_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/pulls{/number}","milestones_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/milestones{/number}","notifications_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/labels{/name}","releases_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/releases{/id}","deployments_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/deployments","created_at":"2015-10-20T16:15:00Z","updated_at":"2016-09-23T14:57:44Z","pushed_at":"2016-09-27T15:43:37Z","git_url":"git://github.com/prolificinteractive/swift-style-guide.git","ssh_url":"git@github.com:prolificinteractive/swift-style-guide.git","clone_url":"https://github.com/prolificinteractive/swift-style-guide.git","svn_url":"https://github.com/prolificinteractive/swift-style-guide","homepage":"","size":172,"stargazers_count":119,"watchers_count":119,"language":null,"has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":8,"mirror_url":null,"open_issues_count":6,"forks":8,"open_issues":6,"watchers":119,"default_branch":"master"}},"base":{"label":"prolificinteractive:master","ref":"master","sha":"41e556fc7d261dda0b68f2a03aff550d72df948f","user":{"login":"prolificinteractive","id":1280427,"avatar_url":"https://avatars.githubusercontent.com/u/1280427?v=3","gravatar_id":"","url":"https://api.github.com/users/prolificinteractive","html_url":"https://github.com/prolificinteractive","followers_url":"https://api.github.com/users/prolificinteractive/followers","following_url":"https://api.github.com/users/prolificinteractive/following{/other_user}","gists_url":"https://api.github.com/users/prolificinteractive/gists{/gist_id}","starred_url":"https://api.github.com/users/prolificinteractive/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/prolificinteractive/subscriptions","organizations_url":"https://api.github.com/users/prolificinteractive/orgs","repos_url":"https://api.github.com/users/prolificinteractive/repos","events_url":"https://api.github.com/users/prolificinteractive/events{/privacy}","received_events_url":"https://api.github.com/users/prolificinteractive/received_events","type":"Organization","site_admin":false},"repo":{"id":44618802,"name":"swift-style-guide","full_name":"prolificinteractive/swift-style-guide","owner":{"login":"prolificinteractive","id":1280427,"avatar_url":"https://avatars.githubusercontent.com/u/1280427?v=3","gravatar_id":"","url":"https://api.github.com/users/prolificinteractive","html_url":"https://github.com/prolificinteractive","followers_url":"https://api.github.com/users/prolificinteractive/followers","following_url":"https://api.github.com/users/prolificinteractive/following{/other_user}","gists_url":"https://api.github.com/users/prolificinteractive/gists{/gist_id}","starred_url":"https://api.github.com/users/prolificinteractive/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/prolificinteractive/subscriptions","organizations_url":"https://api.github.com/users/prolificinteractive/orgs","repos_url":"https://api.github.com/users/prolificinteractive/repos","events_url":"https://api.github.com/users/prolificinteractive/events{/privacy}","received_events_url":"https://api.github.com/users/prolificinteractive/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/prolificinteractive/swift-style-guide","description":"A style guide for Swift.","fork":false,"url":"https://api.github.com/repos/prolificinteractive/swift-style-guide","forks_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/forks","keys_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/keys{/key_id}","collaborators_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/teams","hooks_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/hooks","issue_events_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/issues/events{/number}","events_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/events","assignees_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/assignees{/user}","branches_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/branches{/branch}","tags_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/tags","blobs_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/git/refs{/sha}","trees_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/git/trees{/sha}","statuses_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/statuses/{sha}","languages_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/languages","stargazers_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/stargazers","contributors_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/contributors","subscribers_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/subscribers","subscription_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/subscription","commits_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/commits{/sha}","git_commits_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/git/commits{/sha}","comments_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/comments{/number}","issue_comment_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/issues/comments{/number}","contents_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/contents/{+path}","compare_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/compare/{base}...{head}","merges_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/merges","archive_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/downloads","issues_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/issues{/number}","pulls_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/pulls{/number}","milestones_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/milestones{/number}","notifications_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/labels{/name}","releases_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/releases{/id}","deployments_url":"https://api.github.com/repos/prolificinteractive/swift-style-guide/deployments","created_at":"2015-10-20T16:15:00Z","updated_at":"2016-09-23T14:57:44Z","pushed_at":"2016-09-27T15:43:37Z","git_url":"git://github.com/prolificinteractive/swift-style-guide.git","ssh_url":"git@github.com:prolificinteractive/swift-style-guide.git","clone_url":"https://github.com/prolificinteractive/swift-style-guide.git","svn_url":"https://github.com/prolificinteractive/swift-style-guide","homepage":"","size":172,"stargazers_count":119,"watchers_count":119,"language":null,"has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":8,"mirror_url":null,"open_issues_count":6,"forks":8,"open_issues":6,"watchers":119,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/prolificinteractive/swift-style-guide/pulls/45"},"html":{"href":"https://github.com/prolificinteractive/swift-style-guide/pull/45"},"issue":{"href":"https://api.github.com/repos/prolificinteractive/swift-style-guide/issues/45"},"comments":{"href":"https://api.github.com/repos/prolificinteractive/swift-style-guide/issues/45/comments"},"review_comments":{"href":"https://api.github.com/repos/prolificinteractive/swift-style-guide/pulls/45/comments"},"review_comment":{"href":"https://api.github.com/repos/prolificinteractive/swift-style-guide/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/prolificinteractive/swift-style-guide/pulls/45/commits"},"statuses":{"href":"https://api.github.com/repos/prolificinteractive/swift-style-guide/statuses/a5590b4b57ff89c74e014970af5a3186772a2bb2"}}}}
{"actor":{"display_login":"paulmiard"}}