{"action":"created","comment":{"url":"https://api.github.com/repos/18F/cg-style/pulls/comments/91637141","pull_request_review_id":12147385,"id":91637141,"diff_hunk":"@@ -0,0 +1,60 @@\n+\n+# Contributing\n+\n+<a name=\"development\" id=\"development\"></a>\n+## Development and contributing setup\n+\n+These instructions explain how to develop the cloudgov style while using it on another (companion) site. This allows to see the result of the style changes on an actual site.\n+\n+0. Ensure node/npm is installed. To ensure you're using the most recent version of node that this project supports, use [nvm](https://github.com/creationix/nvm).\n+0. Run `git clone git@github.com:18F/cg-style.git cloudgov-style` if you haven't done so already.\n+0. Enter the project directory with `cd cloudgov-style`.\n+0. If using **nvm**, run `nvm use`. Otherwise, try and install the node version that is in `.nvmrc`.\n+0. Run `npm install` in the `cloudgov-style` repo.\n+0. Run `npm run build` in the `cloudgov-style` repo.\n+0. In the *cloudgov-style* repo, link the current module by running `npm link` in the root of the repo.\n+0. In the companion site repo, link the *cloudgov-style* repo by running `npm link cloudgov-style` in the root of the repo.\n+\n+   - Confirm that the cg-style folder exists in `node_modules` folder.\n+\n+0. In the *cloudgov-style* repo, watch the files and continually build by running `npm install && npm run watch`.\n+0. If developing cg-style with either `cg-dashboard` or `cg-site`, run `npm run watch` in that project directory.\n+If using cg-style on a new project or a project that isn't already using cg-style:\n+\n+0. In the companion site repo, import cg style into the main sass file: `@import \"../node_modules/cloudgov-style/css/cg_style.scss\";`.\n+0. In the companion site repo, run sass to build the *cg-style* repo into the css. This is best done through a script in package.json: `\"build\": \"node-sass static_src/main.scss static/css/main.css\"`\n+\n+When writing styling code, make changes in the *cloudgov-style* repo, run `npm run watch` in the *cloudgov-style* repo, run `npm run build` in the companion site repo, and changes should be built. Alternatively, both repos have a watch task which can be run with `npm run watch` to allow changes to propegate automatically.\n+\n+## Coding style\n+\n+There is a coding standards document that dictates standards and suggestions for how to write code: [documentation/frontend_standards.md](documentation/frontend_standards.md).\n+\n+Run `npm run lint` to lint the codebase for style problems.\n+\n+When developing new components for the style library, ensure you add component documentation in `docs/src/components`.","path":"CONTRIBUTING.md","position":35,"original_position":35,"commit_id":"d058b609ecc2f1e684d6f1eaa69d29bba31bc824","original_commit_id":"d058b609ecc2f1e684d6f1eaa69d29bba31bc824","user":{"login":"adborden","id":509703,"avatar_url":"https://avatars.githubusercontent.com/u/509703?v=3","gravatar_id":"","url":"https://api.github.com/users/adborden","html_url":"https://github.com/adborden","followers_url":"https://api.github.com/users/adborden/followers","following_url":"https://api.github.com/users/adborden/following{/other_user}","gists_url":"https://api.github.com/users/adborden/gists{/gist_id}","starred_url":"https://api.github.com/users/adborden/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/adborden/subscriptions","organizations_url":"https://api.github.com/users/adborden/orgs","repos_url":"https://api.github.com/users/adborden/repos","events_url":"https://api.github.com/users/adborden/events{/privacy}","received_events_url":"https://api.github.com/users/adborden/received_events","type":"User","site_admin":false},"body":"`s/style library/pattern library/` please.","created_at":"2016-12-09T00:19:58Z","updated_at":"2016-12-09T00:19:58Z","html_url":"https://github.com/18F/cg-style/pull/206#discussion_r91637141","pull_request_url":"https://api.github.com/repos/18F/cg-style/pulls/206","_links":{"self":{"href":"https://api.github.com/repos/18F/cg-style/pulls/comments/91637141"},"html":{"href":"https://github.com/18F/cg-style/pull/206#discussion_r91637141"},"pull_request":{"href":"https://api.github.com/repos/18F/cg-style/pulls/206"}}},"pull_request":{"url":"https://api.github.com/repos/18F/cg-style/pulls/206","id":97217780,"html_url":"https://github.com/18F/cg-style/pull/206","diff_url":"https://github.com/18F/cg-style/pull/206.diff","patch_url":"https://github.com/18F/cg-style/pull/206.patch","issue_url":"https://api.github.com/repos/18F/cg-style/issues/206","number":206,"state":"open","locked":false,"title":"Remove jekyll documentation","user":{"login":"msecret","id":1701077,"avatar_url":"https://avatars.githubusercontent.com/u/1701077?v=3","gravatar_id":"","url":"https://api.github.com/users/msecret","html_url":"https://github.com/msecret","followers_url":"https://api.github.com/users/msecret/followers","following_url":"https://api.github.com/users/msecret/following{/other_user}","gists_url":"https://api.github.com/users/msecret/gists{/gist_id}","starred_url":"https://api.github.com/users/msecret/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/msecret/subscriptions","organizations_url":"https://api.github.com/users/msecret/orgs","repos_url":"https://api.github.com/users/msecret/repos","events_url":"https://api.github.com/users/msecret/events{/privacy}","received_events_url":"https://api.github.com/users/msecret/received_events","type":"User","site_admin":false},"body":"Also makes an effort to update and improve the project documentation\r\nby separating contributing information from install/use information\r\ninto a separate contributing file.\r\n\r\nRefs https://github.com/18F/cg-style/issues/178","created_at":"2016-12-08T22:57:34Z","updated_at":"2016-12-09T00:30:23Z","closed_at":null,"merged_at":null,"merge_commit_sha":"f65452dfcd3862dcd40849b3eb6d11ff2dd4bd93","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/18F/cg-style/pulls/206/commits","review_comments_url":"https://api.github.com/repos/18F/cg-style/pulls/206/comments","review_comment_url":"https://api.github.com/repos/18F/cg-style/pulls/comments{/number}","comments_url":"https://api.github.com/repos/18F/cg-style/issues/206/comments","statuses_url":"https://api.github.com/repos/18F/cg-style/statuses/d058b609ecc2f1e684d6f1eaa69d29bba31bc824","head":{"label":"18F:ms-remove_jekyll_docs","ref":"ms-remove_jekyll_docs","sha":"d058b609ecc2f1e684d6f1eaa69d29bba31bc824","user":{"login":"18F","id":6233994,"avatar_url":"https://avatars.githubusercontent.com/u/6233994?v=3","gravatar_id":"","url":"https://api.github.com/users/18F","html_url":"https://github.com/18F","followers_url":"https://api.github.com/users/18F/followers","following_url":"https://api.github.com/users/18F/following{/other_user}","gists_url":"https://api.github.com/users/18F/gists{/gist_id}","starred_url":"https://api.github.com/users/18F/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/18F/subscriptions","organizations_url":"https://api.github.com/users/18F/orgs","repos_url":"https://api.github.com/users/18F/repos","events_url":"https://api.github.com/users/18F/events{/privacy}","received_events_url":"https://api.github.com/users/18F/received_events","type":"Organization","site_admin":false},"repo":{"id":49169967,"name":"cg-style","full_name":"18F/cg-style","owner":{"login":"18F","id":6233994,"avatar_url":"https://avatars.githubusercontent.com/u/6233994?v=3","gravatar_id":"","url":"https://api.github.com/users/18F","html_url":"https://github.com/18F","followers_url":"https://api.github.com/users/18F/followers","following_url":"https://api.github.com/users/18F/following{/other_user}","gists_url":"https://api.github.com/users/18F/gists{/gist_id}","starred_url":"https://api.github.com/users/18F/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/18F/subscriptions","organizations_url":"https://api.github.com/users/18F/orgs","repos_url":"https://api.github.com/users/18F/repos","events_url":"https://api.github.com/users/18F/events{/privacy}","received_events_url":"https://api.github.com/users/18F/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/18F/cg-style","description":"The global style of cloud.gov","fork":false,"url":"https://api.github.com/repos/18F/cg-style","forks_url":"https://api.github.com/repos/18F/cg-style/forks","keys_url":"https://api.github.com/repos/18F/cg-style/keys{/key_id}","collaborators_url":"https://api.github.com/repos/18F/cg-style/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/18F/cg-style/teams","hooks_url":"https://api.github.com/repos/18F/cg-style/hooks","issue_events_url":"https://api.github.com/repos/18F/cg-style/issues/events{/number}","events_url":"https://api.github.com/repos/18F/cg-style/events","assignees_url":"https://api.github.com/repos/18F/cg-style/assignees{/user}","branches_url":"https://api.github.com/repos/18F/cg-style/branches{/branch}","tags_url":"https://api.github.com/repos/18F/cg-style/tags","blobs_url":"https://api.github.com/repos/18F/cg-style/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/18F/cg-style/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/18F/cg-style/git/refs{/sha}","trees_url":"https://api.github.com/repos/18F/cg-style/git/trees{/sha}","statuses_url":"https://api.github.com/repos/18F/cg-style/statuses/{sha}","languages_url":"https://api.github.com/repos/18F/cg-style/languages","stargazers_url":"https://api.github.com/repos/18F/cg-style/stargazers","contributors_url":"https://api.github.com/repos/18F/cg-style/contributors","subscribers_url":"https://api.github.com/repos/18F/cg-style/subscribers","subscription_url":"https://api.github.com/repos/18F/cg-style/subscription","commits_url":"https://api.github.com/repos/18F/cg-style/commits{/sha}","git_commits_url":"https://api.github.com/repos/18F/cg-style/git/commits{/sha}","comments_url":"https://api.github.com/repos/18F/cg-style/comments{/number}","issue_comment_url":"https://api.github.com/repos/18F/cg-style/issues/comments{/number}","contents_url":"https://api.github.com/repos/18F/cg-style/contents/{+path}","compare_url":"https://api.github.com/repos/18F/cg-style/compare/{base}...{head}","merges_url":"https://api.github.com/repos/18F/cg-style/merges","archive_url":"https://api.github.com/repos/18F/cg-style/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/18F/cg-style/downloads","issues_url":"https://api.github.com/repos/18F/cg-style/issues{/number}","pulls_url":"https://api.github.com/repos/18F/cg-style/pulls{/number}","milestones_url":"https://api.github.com/repos/18F/cg-style/milestones{/number}","notifications_url":"https://api.github.com/repos/18F/cg-style/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/18F/cg-style/labels{/name}","releases_url":"https://api.github.com/repos/18F/cg-style/releases{/id}","deployments_url":"https://api.github.com/repos/18F/cg-style/deployments","created_at":"2016-01-07T00:19:06Z","updated_at":"2016-11-15T23:35:57Z","pushed_at":"2016-12-08T22:57:34Z","git_url":"git://github.com/18F/cg-style.git","ssh_url":"git@github.com:18F/cg-style.git","clone_url":"https://github.com/18F/cg-style.git","svn_url":"https://github.com/18F/cg-style","homepage":"https://styleguide.fr.cloud.gov","size":10427,"stargazers_count":14,"watchers_count":14,"language":"CSS","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":6,"mirror_url":null,"open_issues_count":9,"forks":6,"open_issues":9,"watchers":14,"default_branch":"master"}},"base":{"label":"18F:master","ref":"master","sha":"9e9c3af1c2d93b793245109718b2b8203fb4144d","user":{"login":"18F","id":6233994,"avatar_url":"https://avatars.githubusercontent.com/u/6233994?v=3","gravatar_id":"","url":"https://api.github.com/users/18F","html_url":"https://github.com/18F","followers_url":"https://api.github.com/users/18F/followers","following_url":"https://api.github.com/users/18F/following{/other_user}","gists_url":"https://api.github.com/users/18F/gists{/gist_id}","starred_url":"https://api.github.com/users/18F/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/18F/subscriptions","organizations_url":"https://api.github.com/users/18F/orgs","repos_url":"https://api.github.com/users/18F/repos","events_url":"https://api.github.com/users/18F/events{/privacy}","received_events_url":"https://api.github.com/users/18F/received_events","type":"Organization","site_admin":false},"repo":{"id":49169967,"name":"cg-style","full_name":"18F/cg-style","owner":{"login":"18F","id":6233994,"avatar_url":"https://avatars.githubusercontent.com/u/6233994?v=3","gravatar_id":"","url":"https://api.github.com/users/18F","html_url":"https://github.com/18F","followers_url":"https://api.github.com/users/18F/followers","following_url":"https://api.github.com/users/18F/following{/other_user}","gists_url":"https://api.github.com/users/18F/gists{/gist_id}","starred_url":"https://api.github.com/users/18F/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/18F/subscriptions","organizations_url":"https://api.github.com/users/18F/orgs","repos_url":"https://api.github.com/users/18F/repos","events_url":"https://api.github.com/users/18F/events{/privacy}","received_events_url":"https://api.github.com/users/18F/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/18F/cg-style","description":"The global style of cloud.gov","fork":false,"url":"https://api.github.com/repos/18F/cg-style","forks_url":"https://api.github.com/repos/18F/cg-style/forks","keys_url":"https://api.github.com/repos/18F/cg-style/keys{/key_id}","collaborators_url":"https://api.github.com/repos/18F/cg-style/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/18F/cg-style/teams","hooks_url":"https://api.github.com/repos/18F/cg-style/hooks","issue_events_url":"https://api.github.com/repos/18F/cg-style/issues/events{/number}","events_url":"https://api.github.com/repos/18F/cg-style/events","assignees_url":"https://api.github.com/repos/18F/cg-style/assignees{/user}","branches_url":"https://api.github.com/repos/18F/cg-style/branches{/branch}","tags_url":"https://api.github.com/repos/18F/cg-style/tags","blobs_url":"https://api.github.com/repos/18F/cg-style/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/18F/cg-style/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/18F/cg-style/git/refs{/sha}","trees_url":"https://api.github.com/repos/18F/cg-style/git/trees{/sha}","statuses_url":"https://api.github.com/repos/18F/cg-style/statuses/{sha}","languages_url":"https://api.github.com/repos/18F/cg-style/languages","stargazers_url":"https://api.github.com/repos/18F/cg-style/stargazers","contributors_url":"https://api.github.com/repos/18F/cg-style/contributors","subscribers_url":"https://api.github.com/repos/18F/cg-style/subscribers","subscription_url":"https://api.github.com/repos/18F/cg-style/subscription","commits_url":"https://api.github.com/repos/18F/cg-style/commits{/sha}","git_commits_url":"https://api.github.com/repos/18F/cg-style/git/commits{/sha}","comments_url":"https://api.github.com/repos/18F/cg-style/comments{/number}","issue_comment_url":"https://api.github.com/repos/18F/cg-style/issues/comments{/number}","contents_url":"https://api.github.com/repos/18F/cg-style/contents/{+path}","compare_url":"https://api.github.com/repos/18F/cg-style/compare/{base}...{head}","merges_url":"https://api.github.com/repos/18F/cg-style/merges","archive_url":"https://api.github.com/repos/18F/cg-style/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/18F/cg-style/downloads","issues_url":"https://api.github.com/repos/18F/cg-style/issues{/number}","pulls_url":"https://api.github.com/repos/18F/cg-style/pulls{/number}","milestones_url":"https://api.github.com/repos/18F/cg-style/milestones{/number}","notifications_url":"https://api.github.com/repos/18F/cg-style/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/18F/cg-style/labels{/name}","releases_url":"https://api.github.com/repos/18F/cg-style/releases{/id}","deployments_url":"https://api.github.com/repos/18F/cg-style/deployments","created_at":"2016-01-07T00:19:06Z","updated_at":"2016-11-15T23:35:57Z","pushed_at":"2016-12-08T22:57:34Z","git_url":"git://github.com/18F/cg-style.git","ssh_url":"git@github.com:18F/cg-style.git","clone_url":"https://github.com/18F/cg-style.git","svn_url":"https://github.com/18F/cg-style","homepage":"https://styleguide.fr.cloud.gov","size":10427,"stargazers_count":14,"watchers_count":14,"language":"CSS","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":6,"mirror_url":null,"open_issues_count":9,"forks":6,"open_issues":9,"watchers":14,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/18F/cg-style/pulls/206"},"html":{"href":"https://github.com/18F/cg-style/pull/206"},"issue":{"href":"https://api.github.com/repos/18F/cg-style/issues/206"},"comments":{"href":"https://api.github.com/repos/18F/cg-style/issues/206/comments"},"review_comments":{"href":"https://api.github.com/repos/18F/cg-style/pulls/206/comments"},"review_comment":{"href":"https://api.github.com/repos/18F/cg-style/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/18F/cg-style/pulls/206/commits"},"statuses":{"href":"https://api.github.com/repos/18F/cg-style/statuses/d058b609ecc2f1e684d6f1eaa69d29bba31bc824"}}}}
{"actor":{"display_login":"adborden"}}