payload: {"action":"created","comment":{"url":"https://api.github.com/repos/Shopify/shopify-app-cli/pulls/comments/312525923","pull_request_review_id":273192636,"id":312525923,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDMxMjUyNTkyMw==","diff_hunk":"@@ -15,6 +26,32 @@ The user understands the basic mechanics of a CLI:\n - CTRL + C quits any running task\n - how to navigate and manipulate the filesystem via the command line: cd and mkdir\n \n+## Components of a well designed command\n+When creating a new command or subcommand there are a few things to keep in mind.\n+\n+### Reduce user input\n+When trying to create parity with an existing GUI based feature, consider the larger task at hand and build your command to accomplish that goal. \n+\n+For example when creating a `dev-store` the data model requires up to 8 fields to be filled in. When creating a CLI command to create a `dev-store`, don't ask the user for all 8 fields - auto-fill all 8 fields with smart generated data. If a field requires an address dont generate an animal name, try to get as close as possible to the format the data expects.\n+\n+### Allow arguments for key options\n+Argumemnts allow the user to override a commands default execution. For example if we run `shopify populate products` the default will be to create 5 products. However if the user wanted more then 5 products to be generated they could use an argument to override the defaults which would look it would look like this `shopify populate products --count=20`.","path":".github/DESIGN.md","position":30,"original_position":30,"commit_id":"b917d847e44ddb077a37353c0dcfd5a78bd4f1dc","original_commit_id":"b917d847e44ddb077a37353c0dcfd5a78bd4f1dc","user":{"login":"gfscott","id":547470,"node_id":"MDQ6VXNlcjU0NzQ3MA==","avatar_url":"https://avatars1.githubusercontent.com/u/547470?v=4","gravatar_id":"","url":"https://api.github.com/users/gfscott","html_url":"https://github.com/gfscott","followers_url":"https://api.github.com/users/gfscott/followers","following_url":"https://api.github.com/users/gfscott/following{/other_user}","gists_url":"https://api.github.com/users/gfscott/gists{/gist_id}","starred_url":"https://api.github.com/users/gfscott/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gfscott/subscriptions","organizations_url":"https://api.github.com/users/gfscott/orgs","repos_url":"https://api.github.com/users/gfscott/repos","events_url":"https://api.github.com/users/gfscott/events{/privacy}","received_events_url":"https://api.github.com/users/gfscott/received_events","type":"User","site_admin":false},"body":"Typo fixes below, also isn't the `populate` default 10 products? Also, is the override `--count=20` or `--count 20`, with no `=`?\r\n\r\n> Arguments allow the user to override a command’s default execution. For example if we run `shopify populate products`, the default will be to create 5 products. However, if the user wanted more than 5 products to be generated, they could use an argument to override the defaults: `shopify populate products --count=20`.","created_at":"2019-08-09T15:11:56Z","updated_at":"2019-08-09T15:15:12Z","html_url":"https://github.com/Shopify/shopify-app-cli/pull/272#discussion_r312525923","pull_request_url":"https://api.github.com/repos/Shopify/shopify-app-cli/pulls/272","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/Shopify/shopify-app-cli/pulls/comments/312525923"},"html":{"href":"https://github.com/Shopify/shopify-app-cli/pull/272#discussion_r312525923"},"pull_request":{"href":"https://api.github.com/repos/Shopify/shopify-app-cli/pulls/272"}}},"pull_request":{"url":"https://api.github.com/repos/Shopify/shopify-app-cli/pulls/272","id":306012249,"node_id":"MDExOlB1bGxSZXF1ZXN0MzA2MDEyMjQ5","html_url":"https://github.com/Shopify/shopify-app-cli/pull/272","diff_url":"https://github.com/Shopify/shopify-app-cli/pull/272.diff","patch_url":"https://github.com/Shopify/shopify-app-cli/pull/272.patch","issue_url":"https://api.github.com/repos/Shopify/shopify-app-cli/issues/272","number":272,"state":"open","locked":false,"title":"Add components of a good command to DESIGN.MD","user":{"login":"davekilljoy","id":1523373,"node_id":"MDQ6VXNlcjE1MjMzNzM=","avatar_url":"https://avatars3.githubusercontent.com/u/1523373?v=4","gravatar_id":"","url":"https://api.github.com/users/davekilljoy","html_url":"https://github.com/davekilljoy","followers_url":"https://api.github.com/users/davekilljoy/followers","following_url":"https://api.github.com/users/davekilljoy/following{/other_user}","gists_url":"https://api.github.com/users/davekilljoy/gists{/gist_id}","starred_url":"https://api.github.com/users/davekilljoy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/davekilljoy/subscriptions","organizations_url":"https://api.github.com/users/davekilljoy/orgs","repos_url":"https://api.github.com/users/davekilljoy/repos","events_url":"https://api.github.com/users/davekilljoy/events{/privacy}","received_events_url":"https://api.github.com/users/davekilljoy/received_events","type":"User","site_admin":false},"body":"### WHY are these changes introduced?\r\n\r\nI noticed a gap in the content, that we needed to supply more information about what a good command looks like and what things you should consider when creating a good command like help and code comments.\r\n\r\n### WHAT is this pull request doing?\r\n\r\nAdding content to address the gap.\r\n","created_at":"2019-08-09T14:23:39Z","updated_at":"2019-08-09T15:15:11Z","closed_at":null,"merged_at":null,"merge_commit_sha":"0a9385a496b8a58da4a45b513ab0375dbc993749","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/Shopify/shopify-app-cli/pulls/272/commits","review_comments_url":"https://api.github.com/repos/Shopify/shopify-app-cli/pulls/272/comments","review_comment_url":"https://api.github.com/repos/Shopify/shopify-app-cli/pulls/comments{/number}","comments_url":"https://api.github.com/repos/Shopify/shopify-app-cli/issues/272/comments","statuses_url":"https://api.github.com/repos/Shopify/shopify-app-cli/statuses/b917d847e44ddb077a37353c0dcfd5a78bd4f1dc","head":{"label":"Shopify:design-updates","ref":"design-updates","sha":"b917d847e44ddb077a37353c0dcfd5a78bd4f1dc","user":{"login":"Shopify","id":8085,"node_id":"MDEyOk9yZ2FuaXphdGlvbjgwODU=","avatar_url":"https://avatars1.githubusercontent.com/u/8085?v=4","gravatar_id":"","url":"https://api.github.com/users/Shopify","html_url":"https://github.com/Shopify","followers_url":"https://api.github.com/users/Shopify/followers","following_url":"https://api.github.com/users/Shopify/following{/other_user}","gists_url":"https://api.github.com/users/Shopify/gists{/gist_id}","starred_url":"https://api.github.com/users/Shopify/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Shopify/subscriptions","organizations_url":"https://api.github.com/users/Shopify/orgs","repos_url":"https://api.github.com/users/Shopify/repos","events_url":"https://api.github.com/users/Shopify/events{/privacy}","received_events_url":"https://api.github.com/users/Shopify/received_events","type":"Organization","site_admin":false},"repo":{"id":161399160,"node_id":"MDEwOlJlcG9zaXRvcnkxNjEzOTkxNjA=","name":"shopify-app-cli","full_name":"Shopify/shopify-app-cli","private":false,"owner":{"login":"Shopify","id":8085,"node_id":"MDEyOk9yZ2FuaXphdGlvbjgwODU=","avatar_url":"https://avatars1.githubusercontent.com/u/8085?v=4","gravatar_id":"","url":"https://api.github.com/users/Shopify","html_url":"https://github.com/Shopify","followers_url":"https://api.github.com/users/Shopify/followers","following_url":"https://api.github.com/users/Shopify/following{/other_user}","gists_url":"https://api.github.com/users/Shopify/gists{/gist_id}","starred_url":"https://api.github.com/users/Shopify/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Shopify/subscriptions","organizations_url":"https://api.github.com/users/Shopify/orgs","repos_url":"https://api.github.com/users/Shopify/repos","events_url":"https://api.github.com/users/Shopify/events{/privacy}","received_events_url":"https://api.github.com/users/Shopify/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/Shopify/shopify-app-cli","description":"Shopify App CLI helps you build Shopify apps faster.","fork":false,"url":"https://api.github.com/repos/Shopify/shopify-app-cli","forks_url":"https://api.github.com/repos/Shopify/shopify-app-cli/forks","keys_url":"https://api.github.com/repos/Shopify/shopify-app-cli/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Shopify/shopify-app-cli/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Shopify/shopify-app-cli/teams","hooks_url":"https://api.github.com/repos/Shopify/shopify-app-cli/hooks","issue_events_url":"https://api.github.com/repos/Shopify/shopify-app-cli/issues/events{/number}","events_url":"https://api.github.com/repos/Shopify/shopify-app-cli/events","assignees_url":"https://api.github.com/repos/Shopify/shopify-app-cli/assignees{/user}","branches_url":"https://api.github.com/repos/Shopify/shopify-app-cli/branches{/branch}","tags_url":"https://api.github.com/repos/Shopify/shopify-app-cli/tags","blobs_url":"https://api.github.com/repos/Shopify/shopify-app-cli/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Shopify/shopify-app-cli/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Shopify/shopify-app-cli/git/refs{/sha}","trees_url":"https://api.github.com/repos/Shopify/shopify-app-cli/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Shopify/shopify-app-cli/statuses/{sha}","languages_url":"https://api.github.com/repos/Shopify/shopify-app-cli/languages","stargazers_url":"https://api.github.com/repos/Shopify/shopify-app-cli/stargazers","contributors_url":"https://api.github.com/repos/Shopify/shopify-app-cli/contributors","subscribers_url":"https://api.github.com/repos/Shopify/shopify-app-cli/subscribers","subscription_url":"https://api.github.com/repos/Shopify/shopify-app-cli/subscription","commits_url":"https://api.github.com/repos/Shopify/shopify-app-cli/commits{/sha}","git_commits_url":"https://api.github.com/repos/Shopify/shopify-app-cli/git/commits{/sha}","comments_url":"https://api.github.com/repos/Shopify/shopify-app-cli/comments{/number}","issue_comment_url":"https://api.github.com/repos/Shopify/shopify-app-cli/issues/comments{/number}","contents_url":"https://api.github.com/repos/Shopify/shopify-app-cli/contents/{+path}","compare_url":"https://api.github.com/repos/Shopify/shopify-app-cli/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Shopify/shopify-app-cli/merges","archive_url":"https://api.github.com/repos/Shopify/shopify-app-cli/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Shopify/shopify-app-cli/downloads","issues_url":"https://api.github.com/repos/Shopify/shopify-app-cli/issues{/number}","pulls_url":"https://api.github.com/repos/Shopify/shopify-app-cli/pulls{/number}","milestones_url":"https://api.github.com/repos/Shopify/shopify-app-cli/milestones{/number}","notifications_url":"https://api.github.com/repos/Shopify/shopify-app-cli/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Shopify/shopify-app-cli/labels{/name}","releases_url":"https://api.github.com/repos/Shopify/shopify-app-cli/releases{/id}","deployments_url":"https://api.github.com/repos/Shopify/shopify-app-cli/deployments","created_at":"2018-12-11T21:59:47Z","updated_at":"2019-08-08T03:20:06Z","pushed_at":"2019-08-09T14:41:55Z","git_url":"git://github.com/Shopify/shopify-app-cli.git","ssh_url":"git@github.com:Shopify/shopify-app-cli.git","clone_url":"https://github.com/Shopify/shopify-app-cli.git","svn_url":"https://github.com/Shopify/shopify-app-cli","homepage":"","size":29849,"stargazers_count":96,"watchers_count":96,"language":"Ruby","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":15,"mirror_url":null,"archived":false,"disabled":false,"open_issues_count":40,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit","node_id":"MDc6TGljZW5zZTEz"},"forks":15,"open_issues":40,"watchers":96,"default_branch":"master"}},"base":{"label":"Shopify:master","ref":"master","sha":"02c304400caed439c0c7a218ab260311aafdf180","user":{"login":"Shopify","id":8085,"node_id":"MDEyOk9yZ2FuaXphdGlvbjgwODU=","avatar_url":"https://avatars1.githubusercontent.com/u/8085?v=4","gravatar_id":"","url":"https://api.github.com/users/Shopify","html_url":"https://github.com/Shopify","followers_url":"https://api.github.com/users/Shopify/followers","following_url":"https://api.github.com/users/Shopify/following{/other_user}","gists_url":"https://api.github.com/users/Shopify/gists{/gist_id}","starred_url":"https://api.github.com/users/Shopify/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Shopify/subscriptions","organizations_url":"https://api.github.com/users/Shopify/orgs","repos_url":"https://api.github.com/users/Shopify/repos","events_url":"https://api.github.com/users/Shopify/events{/privacy}","received_events_url":"https://api.github.com/users/Shopify/received_events","type":"Organization","site_admin":false},"repo":{"id":161399160,"node_id":"MDEwOlJlcG9zaXRvcnkxNjEzOTkxNjA=","name":"shopify-app-cli","full_name":"Shopify/shopify-app-cli","private":false,"owner":{"login":"Shopify","id":8085,"node_id":"MDEyOk9yZ2FuaXphdGlvbjgwODU=","avatar_url":"https://avatars1.githubusercontent.com/u/8085?v=4","gravatar_id":"","url":"https://api.github.com/users/Shopify","html_url":"https://github.com/Shopify","followers_url":"https://api.github.com/users/Shopify/followers","following_url":"https://api.github.com/users/Shopify/following{/other_user}","gists_url":"https://api.github.com/users/Shopify/gists{/gist_id}","starred_url":"https://api.github.com/users/Shopify/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Shopify/subscriptions","organizations_url":"https://api.github.com/users/Shopify/orgs","repos_url":"https://api.github.com/users/Shopify/repos","events_url":"https://api.github.com/users/Shopify/events{/privacy}","received_events_url":"https://api.github.com/users/Shopify/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/Shopify/shopify-app-cli","description":"Shopify App CLI helps you build Shopify apps faster.","fork":false,"url":"https://api.github.com/repos/Shopify/shopify-app-cli","forks_url":"https://api.github.com/repos/Shopify/shopify-app-cli/forks","keys_url":"https://api.github.com/repos/Shopify/shopify-app-cli/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Shopify/shopify-app-cli/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Shopify/shopify-app-cli/teams","hooks_url":"https://api.github.com/repos/Shopify/shopify-app-cli/hooks","issue_events_url":"https://api.github.com/repos/Shopify/shopify-app-cli/issues/events{/number}","events_url":"https://api.github.com/repos/Shopify/shopify-app-cli/events","assignees_url":"https://api.github.com/repos/Shopify/shopify-app-cli/assignees{/user}","branches_url":"https://api.github.com/repos/Shopify/shopify-app-cli/branches{/branch}","tags_url":"https://api.github.com/repos/Shopify/shopify-app-cli/tags","blobs_url":"https://api.github.com/repos/Shopify/shopify-app-cli/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Shopify/shopify-app-cli/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Shopify/shopify-app-cli/git/refs{/sha}","trees_url":"https://api.github.com/repos/Shopify/shopify-app-cli/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Shopify/shopify-app-cli/statuses/{sha}","languages_url":"https://api.github.com/repos/Shopify/shopify-app-cli/languages","stargazers_url":"https://api.github.com/repos/Shopify/shopify-app-cli/stargazers","contributors_url":"https://api.github.com/repos/Shopify/shopify-app-cli/contributors","subscribers_url":"https://api.github.com/repos/Shopify/shopify-app-cli/subscribers","subscription_url":"https://api.github.com/repos/Shopify/shopify-app-cli/subscription","commits_url":"https://api.github.com/repos/Shopify/shopify-app-cli/commits{/sha}","git_commits_url":"https://api.github.com/repos/Shopify/shopify-app-cli/git/commits{/sha}","comments_url":"https://api.github.com/repos/Shopify/shopify-app-cli/comments{/number}","issue_comment_url":"https://api.github.com/repos/Shopify/shopify-app-cli/issues/comments{/number}","contents_url":"https://api.github.com/repos/Shopify/shopify-app-cli/contents/{+path}","compare_url":"https://api.github.com/repos/Shopify/shopify-app-cli/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Shopify/shopify-app-cli/merges","archive_url":"https://api.github.com/repos/Shopify/shopify-app-cli/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Shopify/shopify-app-cli/downloads","issues_url":"https://api.github.com/repos/Shopify/shopify-app-cli/issues{/number}","pulls_url":"https://api.github.com/repos/Shopify/shopify-app-cli/pulls{/number}","milestones_url":"https://api.github.com/repos/Shopify/shopify-app-cli/milestones{/number}","notifications_url":"https://api.github.com/repos/Shopify/shopify-app-cli/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Shopify/shopify-app-cli/labels{/name}","releases_url":"https://api.github.com/repos/Shopify/shopify-app-cli/releases{/id}","deployments_url":"https://api.github.com/repos/Shopify/shopify-app-cli/deployments","created_at":"2018-12-11T21:59:47Z","updated_at":"2019-08-08T03:20:06Z","pushed_at":"2019-08-09T14:41:55Z","git_url":"git://github.com/Shopify/shopify-app-cli.git","ssh_url":"git@github.com:Shopify/shopify-app-cli.git","clone_url":"https://github.com/Shopify/shopify-app-cli.git","svn_url":"https://github.com/Shopify/shopify-app-cli","homepage":"","size":29849,"stargazers_count":96,"watchers_count":96,"language":"Ruby","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":15,"mirror_url":null,"archived":false,"disabled":false,"open_issues_count":40,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit","node_id":"MDc6TGljZW5zZTEz"},"forks":15,"open_issues":40,"watchers":96,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/Shopify/shopify-app-cli/pulls/272"},"html":{"href":"https://github.com/Shopify/shopify-app-cli/pull/272"},"issue":{"href":"https://api.github.com/repos/Shopify/shopify-app-cli/issues/272"},"comments":{"href":"https://api.github.com/repos/Shopify/shopify-app-cli/issues/272/comments"},"review_comments":{"href":"https://api.github.com/repos/Shopify/shopify-app-cli/pulls/272/comments"},"review_comment":{"href":"https://api.github.com/repos/Shopify/shopify-app-cli/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/Shopify/shopify-app-cli/pulls/272/commits"},"statuses":{"href":"https://api.github.com/repos/Shopify/shopify-app-cli/statuses/b917d847e44ddb077a37353c0dcfd5a78bd4f1dc"}},"author_association":"CONTRIBUTOR"}}
other: {"actor":{"display_login":"gfscott"}}