{"action":"created","comment":{"url":"https://api.github.com/repos/BBC-News/psammead/pulls/comments/244942410","pull_request_review_id":188937570,"id":244942410,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI0NDk0MjQxMA==","diff_hunk":"@@ -89,24 +89,62 @@ The changelog should follow the following convention:\n \n **README**\n \n-The `README.md` should cover the following territory:\n+The `README.md` should follow this template:\n \n ```\n+# (package name) &middot; (badges)\n+\n ## Description\n (high-level summary that will be accessible to product/UX/Test, plus link to Storybook, explain the different cases)\n+\n ## When to use this component\n (including where it is currently used)\n-## When to not use this component\n+\n+## When not to use this component\n (if this is not known, can leave the section empty)\n+\n+## Installation\n+`npm install (package-name)`\n+\n+## Props\n+(a table of all the component's props, following the template below)\n+\n+| Argument  | Type                | Required | Example         |\n+|-----------|---------------------|----------|-----------------|\n+| prop-name | description of type | Yes/No   | `example input` |\n+\n+## Usage\n+(An code block containing an example usage of the component, including importing)\n+\n ## Accessibility notes\n (ensuring they make sense to non-technical audiences)\n+\n ## Roadmap\n (what we have planned for this component)\n+\n ## Additional notes\n (link to any relevant ADRs)\n+\n+## Contributing\n+\n+Psammead is completely open source. We are grateful for any contributions, whether they be new components, bug fixes or general improvements. Please see our primary contributing guide which can be found at [the root of the Psammead respository](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md).\n+\n+### [Code of Conduct](https://github.com/BBC-News/psammead/blob/latest/CODE_OF_CONDUCT.md)\n+\n+We welcome feedback and help on this work. By participating in this project, you agree to abide by the [code of conduct](https://github.com/BBC-News/psammead/blob/latest/CODE_OF_CONDUCT.md). Please take a moment to read it.\n+\n+### License\n+\n+Psammead is [Apache 2.0 licensed](https://github.com/BBC-News/psammead/blob/latest/LICENSE).\n ```\n \n-In addition, the `README.md` should also point to Psammead's [CODE_OF_CONDUCT](https://github.com/BBC-News/psammead/blob/latest/CODE_OF_CONDUCT.md), [CONTRIBUTING](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md) guide, and [LICENSE](https://github.com/BBC-News/psammead/blob/latest/LICENSE).\n+When linking to other pages from a component's README, we advise you do so only by absolute URL, and avoid the use of relative paths. Component READMEs are displayed in a variety of places, including NPM and Storybook, and this helps ensure the intended meaning is preserved.\n+\n+If you wish to exclude one or more sections of this template, we advise you do so by simply commenting out the heading, like so:\n+\n+```\n+<!-- ## Roadmap -->\n+```","path":"CONTRIBUTING.md","position":62,"original_position":62,"commit_id":"ad03794c0769b8c52179b9cb0707672d3ba624d3","original_commit_id":"ad03794c0769b8c52179b9cb0707672d3ba624d3","user":{"login":"ChrisBAshton","id":5111927,"node_id":"MDQ6VXNlcjUxMTE5Mjc=","avatar_url":"https://avatars2.githubusercontent.com/u/5111927?v=4","gravatar_id":"","url":"https://api.github.com/users/ChrisBAshton","html_url":"https://github.com/ChrisBAshton","followers_url":"https://api.github.com/users/ChrisBAshton/followers","following_url":"https://api.github.com/users/ChrisBAshton/following{/other_user}","gists_url":"https://api.github.com/users/ChrisBAshton/gists{/gist_id}","starred_url":"https://api.github.com/users/ChrisBAshton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ChrisBAshton/subscriptions","organizations_url":"https://api.github.com/users/ChrisBAshton/orgs","repos_url":"https://api.github.com/users/ChrisBAshton/repos","events_url":"https://api.github.com/users/ChrisBAshton/events{/privacy}","received_events_url":"https://api.github.com/users/ChrisBAshton/received_events","type":"User","site_admin":false},"body":"Why? Feels a bit unclean 🤔 ","created_at":"2019-01-03T09:22:00Z","updated_at":"2019-01-03T09:30:51Z","html_url":"https://github.com/BBC-News/psammead/pull/245#discussion_r244942410","pull_request_url":"https://api.github.com/repos/BBC-News/psammead/pulls/245","author_association":"COLLABORATOR","_links":{"self":{"href":"https://api.github.com/repos/BBC-News/psammead/pulls/comments/244942410"},"html":{"href":"https://github.com/BBC-News/psammead/pull/245#discussion_r244942410"},"pull_request":{"href":"https://api.github.com/repos/BBC-News/psammead/pulls/245"}}},"pull_request":{"url":"https://api.github.com/repos/BBC-News/psammead/pulls/245","id":240429827,"node_id":"MDExOlB1bGxSZXF1ZXN0MjQwNDI5ODI3","html_url":"https://github.com/BBC-News/psammead/pull/245","diff_url":"https://github.com/BBC-News/psammead/pull/245.diff","patch_url":"https://github.com/BBC-News/psammead/pull/245.patch","issue_url":"https://api.github.com/repos/BBC-News/psammead/issues/245","number":245,"state":"open","locked":false,"title":"Make component documentation more consistent","user":{"login":"bcmn","id":11646957,"node_id":"MDQ6VXNlcjExNjQ2OTU3","avatar_url":"https://avatars3.githubusercontent.com/u/11646957?v=4","gravatar_id":"","url":"https://api.github.com/users/bcmn","html_url":"https://github.com/bcmn","followers_url":"https://api.github.com/users/bcmn/followers","following_url":"https://api.github.com/users/bcmn/following{/other_user}","gists_url":"https://api.github.com/users/bcmn/gists{/gist_id}","starred_url":"https://api.github.com/users/bcmn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bcmn/subscriptions","organizations_url":"https://api.github.com/users/bcmn/orgs","repos_url":"https://api.github.com/users/bcmn/repos","events_url":"https://api.github.com/users/bcmn/events{/privacy}","received_events_url":"https://api.github.com/users/bcmn/received_events","type":"User","site_admin":false},"body":"Resolves #233 \r\n\r\nAdds \"usage\" section to all components READMEs, & helps ensure documentation is more consistent.\r\n\r\n- [x] I have assigned myself to this PR and the corresponding issues\r\n- [ ] Tests added for new features\r\n- [ ] Test engineer approval","created_at":"2018-12-21T10:18:57Z","updated_at":"2019-01-03T09:30:51Z","closed_at":null,"merged_at":null,"merge_commit_sha":"40861ee1b45b6f0fbaf7d6631b62b3da94410920","assignee":{"login":"bcmn","id":11646957,"node_id":"MDQ6VXNlcjExNjQ2OTU3","avatar_url":"https://avatars3.githubusercontent.com/u/11646957?v=4","gravatar_id":"","url":"https://api.github.com/users/bcmn","html_url":"https://github.com/bcmn","followers_url":"https://api.github.com/users/bcmn/followers","following_url":"https://api.github.com/users/bcmn/following{/other_user}","gists_url":"https://api.github.com/users/bcmn/gists{/gist_id}","starred_url":"https://api.github.com/users/bcmn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bcmn/subscriptions","organizations_url":"https://api.github.com/users/bcmn/orgs","repos_url":"https://api.github.com/users/bcmn/repos","events_url":"https://api.github.com/users/bcmn/events{/privacy}","received_events_url":"https://api.github.com/users/bcmn/received_events","type":"User","site_admin":false},"assignees":[{"login":"bcmn","id":11646957,"node_id":"MDQ6VXNlcjExNjQ2OTU3","avatar_url":"https://avatars3.githubusercontent.com/u/11646957?v=4","gravatar_id":"","url":"https://api.github.com/users/bcmn","html_url":"https://github.com/bcmn","followers_url":"https://api.github.com/users/bcmn/followers","following_url":"https://api.github.com/users/bcmn/following{/other_user}","gists_url":"https://api.github.com/users/bcmn/gists{/gist_id}","starred_url":"https://api.github.com/users/bcmn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bcmn/subscriptions","organizations_url":"https://api.github.com/users/bcmn/orgs","repos_url":"https://api.github.com/users/bcmn/repos","events_url":"https://api.github.com/users/bcmn/events{/privacy}","received_events_url":"https://api.github.com/users/bcmn/received_events","type":"User","site_admin":false}],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/BBC-News/psammead/pulls/245/commits","review_comments_url":"https://api.github.com/repos/BBC-News/psammead/pulls/245/comments","review_comment_url":"https://api.github.com/repos/BBC-News/psammead/pulls/comments{/number}","comments_url":"https://api.github.com/repos/BBC-News/psammead/issues/245/comments","statuses_url":"https://api.github.com/repos/BBC-News/psammead/statuses/ad03794c0769b8c52179b9cb0707672d3ba624d3","head":{"label":"BBC-News:consistent-documentation","ref":"consistent-documentation","sha":"ad03794c0769b8c52179b9cb0707672d3ba624d3","user":{"login":"BBC-News","id":1401475,"node_id":"MDEyOk9yZ2FuaXphdGlvbjE0MDE0NzU=","avatar_url":"https://avatars0.githubusercontent.com/u/1401475?v=4","gravatar_id":"","url":"https://api.github.com/users/BBC-News","html_url":"https://github.com/BBC-News","followers_url":"https://api.github.com/users/BBC-News/followers","following_url":"https://api.github.com/users/BBC-News/following{/other_user}","gists_url":"https://api.github.com/users/BBC-News/gists{/gist_id}","starred_url":"https://api.github.com/users/BBC-News/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/BBC-News/subscriptions","organizations_url":"https://api.github.com/users/BBC-News/orgs","repos_url":"https://api.github.com/users/BBC-News/repos","events_url":"https://api.github.com/users/BBC-News/events{/privacy}","received_events_url":"https://api.github.com/users/BBC-News/received_events","type":"Organization","site_admin":false},"repo":{"id":148457207,"node_id":"MDEwOlJlcG9zaXRvcnkxNDg0NTcyMDc=","name":"psammead","full_name":"BBC-News/psammead","private":false,"owner":{"login":"BBC-News","id":1401475,"node_id":"MDEyOk9yZ2FuaXphdGlvbjE0MDE0NzU=","avatar_url":"https://avatars0.githubusercontent.com/u/1401475?v=4","gravatar_id":"","url":"https://api.github.com/users/BBC-News","html_url":"https://github.com/BBC-News","followers_url":"https://api.github.com/users/BBC-News/followers","following_url":"https://api.github.com/users/BBC-News/following{/other_user}","gists_url":"https://api.github.com/users/BBC-News/gists{/gist_id}","starred_url":"https://api.github.com/users/BBC-News/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/BBC-News/subscriptions","organizations_url":"https://api.github.com/users/BBC-News/orgs","repos_url":"https://api.github.com/users/BBC-News/repos","events_url":"https://api.github.com/users/BBC-News/events{/privacy}","received_events_url":"https://api.github.com/users/BBC-News/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/BBC-News/psammead","description":"React component library for BBC Articles and more","fork":false,"url":"https://api.github.com/repos/BBC-News/psammead","forks_url":"https://api.github.com/repos/BBC-News/psammead/forks","keys_url":"https://api.github.com/repos/BBC-News/psammead/keys{/key_id}","collaborators_url":"https://api.github.com/repos/BBC-News/psammead/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/BBC-News/psammead/teams","hooks_url":"https://api.github.com/repos/BBC-News/psammead/hooks","issue_events_url":"https://api.github.com/repos/BBC-News/psammead/issues/events{/number}","events_url":"https://api.github.com/repos/BBC-News/psammead/events","assignees_url":"https://api.github.com/repos/BBC-News/psammead/assignees{/user}","branches_url":"https://api.github.com/repos/BBC-News/psammead/branches{/branch}","tags_url":"https://api.github.com/repos/BBC-News/psammead/tags","blobs_url":"https://api.github.com/repos/BBC-News/psammead/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/BBC-News/psammead/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/BBC-News/psammead/git/refs{/sha}","trees_url":"https://api.github.com/repos/BBC-News/psammead/git/trees{/sha}","statuses_url":"https://api.github.com/repos/BBC-News/psammead/statuses/{sha}","languages_url":"https://api.github.com/repos/BBC-News/psammead/languages","stargazers_url":"https://api.github.com/repos/BBC-News/psammead/stargazers","contributors_url":"https://api.github.com/repos/BBC-News/psammead/contributors","subscribers_url":"https://api.github.com/repos/BBC-News/psammead/subscribers","subscription_url":"https://api.github.com/repos/BBC-News/psammead/subscription","commits_url":"https://api.github.com/repos/BBC-News/psammead/commits{/sha}","git_commits_url":"https://api.github.com/repos/BBC-News/psammead/git/commits{/sha}","comments_url":"https://api.github.com/repos/BBC-News/psammead/comments{/number}","issue_comment_url":"https://api.github.com/repos/BBC-News/psammead/issues/comments{/number}","contents_url":"https://api.github.com/repos/BBC-News/psammead/contents/{+path}","compare_url":"https://api.github.com/repos/BBC-News/psammead/compare/{base}...{head}","merges_url":"https://api.github.com/repos/BBC-News/psammead/merges","archive_url":"https://api.github.com/repos/BBC-News/psammead/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/BBC-News/psammead/downloads","issues_url":"https://api.github.com/repos/BBC-News/psammead/issues{/number}","pulls_url":"https://api.github.com/repos/BBC-News/psammead/pulls{/number}","milestones_url":"https://api.github.com/repos/BBC-News/psammead/milestones{/number}","notifications_url":"https://api.github.com/repos/BBC-News/psammead/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/BBC-News/psammead/labels{/name}","releases_url":"https://api.github.com/repos/BBC-News/psammead/releases{/id}","deployments_url":"https://api.github.com/repos/BBC-News/psammead/deployments","created_at":"2018-09-12T09:41:04Z","updated_at":"2019-01-02T14:08:12Z","pushed_at":"2019-01-02T15:16:54Z","git_url":"git://github.com/BBC-News/psammead.git","ssh_url":"git@github.com:BBC-News/psammead.git","clone_url":"https://github.com/BBC-News/psammead.git","svn_url":"https://github.com/BBC-News/psammead","homepage":"https://bbc-news.github.io/psammead/","size":6087,"stargazers_count":50,"watchers_count":50,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":3,"mirror_url":null,"archived":false,"open_issues_count":38,"license":{"key":"other","name":"Other","spdx_id":"NOASSERTION","url":null,"node_id":"MDc6TGljZW5zZTA="},"forks":3,"open_issues":38,"watchers":50,"default_branch":"latest"}},"base":{"label":"BBC-News:latest","ref":"latest","sha":"1ea318023c79415e46e0f5d9fb3dc1036822a18e","user":{"login":"BBC-News","id":1401475,"node_id":"MDEyOk9yZ2FuaXphdGlvbjE0MDE0NzU=","avatar_url":"https://avatars0.githubusercontent.com/u/1401475?v=4","gravatar_id":"","url":"https://api.github.com/users/BBC-News","html_url":"https://github.com/BBC-News","followers_url":"https://api.github.com/users/BBC-News/followers","following_url":"https://api.github.com/users/BBC-News/following{/other_user}","gists_url":"https://api.github.com/users/BBC-News/gists{/gist_id}","starred_url":"https://api.github.com/users/BBC-News/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/BBC-News/subscriptions","organizations_url":"https://api.github.com/users/BBC-News/orgs","repos_url":"https://api.github.com/users/BBC-News/repos","events_url":"https://api.github.com/users/BBC-News/events{/privacy}","received_events_url":"https://api.github.com/users/BBC-News/received_events","type":"Organization","site_admin":false},"repo":{"id":148457207,"node_id":"MDEwOlJlcG9zaXRvcnkxNDg0NTcyMDc=","name":"psammead","full_name":"BBC-News/psammead","private":false,"owner":{"login":"BBC-News","id":1401475,"node_id":"MDEyOk9yZ2FuaXphdGlvbjE0MDE0NzU=","avatar_url":"https://avatars0.githubusercontent.com/u/1401475?v=4","gravatar_id":"","url":"https://api.github.com/users/BBC-News","html_url":"https://github.com/BBC-News","followers_url":"https://api.github.com/users/BBC-News/followers","following_url":"https://api.github.com/users/BBC-News/following{/other_user}","gists_url":"https://api.github.com/users/BBC-News/gists{/gist_id}","starred_url":"https://api.github.com/users/BBC-News/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/BBC-News/subscriptions","organizations_url":"https://api.github.com/users/BBC-News/orgs","repos_url":"https://api.github.com/users/BBC-News/repos","events_url":"https://api.github.com/users/BBC-News/events{/privacy}","received_events_url":"https://api.github.com/users/BBC-News/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/BBC-News/psammead","description":"React component library for BBC Articles and more","fork":false,"url":"https://api.github.com/repos/BBC-News/psammead","forks_url":"https://api.github.com/repos/BBC-News/psammead/forks","keys_url":"https://api.github.com/repos/BBC-News/psammead/keys{/key_id}","collaborators_url":"https://api.github.com/repos/BBC-News/psammead/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/BBC-News/psammead/teams","hooks_url":"https://api.github.com/repos/BBC-News/psammead/hooks","issue_events_url":"https://api.github.com/repos/BBC-News/psammead/issues/events{/number}","events_url":"https://api.github.com/repos/BBC-News/psammead/events","assignees_url":"https://api.github.com/repos/BBC-News/psammead/assignees{/user}","branches_url":"https://api.github.com/repos/BBC-News/psammead/branches{/branch}","tags_url":"https://api.github.com/repos/BBC-News/psammead/tags","blobs_url":"https://api.github.com/repos/BBC-News/psammead/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/BBC-News/psammead/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/BBC-News/psammead/git/refs{/sha}","trees_url":"https://api.github.com/repos/BBC-News/psammead/git/trees{/sha}","statuses_url":"https://api.github.com/repos/BBC-News/psammead/statuses/{sha}","languages_url":"https://api.github.com/repos/BBC-News/psammead/languages","stargazers_url":"https://api.github.com/repos/BBC-News/psammead/stargazers","contributors_url":"https://api.github.com/repos/BBC-News/psammead/contributors","subscribers_url":"https://api.github.com/repos/BBC-News/psammead/subscribers","subscription_url":"https://api.github.com/repos/BBC-News/psammead/subscription","commits_url":"https://api.github.com/repos/BBC-News/psammead/commits{/sha}","git_commits_url":"https://api.github.com/repos/BBC-News/psammead/git/commits{/sha}","comments_url":"https://api.github.com/repos/BBC-News/psammead/comments{/number}","issue_comment_url":"https://api.github.com/repos/BBC-News/psammead/issues/comments{/number}","contents_url":"https://api.github.com/repos/BBC-News/psammead/contents/{+path}","compare_url":"https://api.github.com/repos/BBC-News/psammead/compare/{base}...{head}","merges_url":"https://api.github.com/repos/BBC-News/psammead/merges","archive_url":"https://api.github.com/repos/BBC-News/psammead/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/BBC-News/psammead/downloads","issues_url":"https://api.github.com/repos/BBC-News/psammead/issues{/number}","pulls_url":"https://api.github.com/repos/BBC-News/psammead/pulls{/number}","milestones_url":"https://api.github.com/repos/BBC-News/psammead/milestones{/number}","notifications_url":"https://api.github.com/repos/BBC-News/psammead/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/BBC-News/psammead/labels{/name}","releases_url":"https://api.github.com/repos/BBC-News/psammead/releases{/id}","deployments_url":"https://api.github.com/repos/BBC-News/psammead/deployments","created_at":"2018-09-12T09:41:04Z","updated_at":"2019-01-02T14:08:12Z","pushed_at":"2019-01-02T15:16:54Z","git_url":"git://github.com/BBC-News/psammead.git","ssh_url":"git@github.com:BBC-News/psammead.git","clone_url":"https://github.com/BBC-News/psammead.git","svn_url":"https://github.com/BBC-News/psammead","homepage":"https://bbc-news.github.io/psammead/","size":6087,"stargazers_count":50,"watchers_count":50,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":3,"mirror_url":null,"archived":false,"open_issues_count":38,"license":{"key":"other","name":"Other","spdx_id":"NOASSERTION","url":null,"node_id":"MDc6TGljZW5zZTA="},"forks":3,"open_issues":38,"watchers":50,"default_branch":"latest"}},"_links":{"self":{"href":"https://api.github.com/repos/BBC-News/psammead/pulls/245"},"html":{"href":"https://github.com/BBC-News/psammead/pull/245"},"issue":{"href":"https://api.github.com/repos/BBC-News/psammead/issues/245"},"comments":{"href":"https://api.github.com/repos/BBC-News/psammead/issues/245/comments"},"review_comments":{"href":"https://api.github.com/repos/BBC-News/psammead/pulls/245/comments"},"review_comment":{"href":"https://api.github.com/repos/BBC-News/psammead/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/BBC-News/psammead/pulls/245/commits"},"statuses":{"href":"https://api.github.com/repos/BBC-News/psammead/statuses/ad03794c0769b8c52179b9cb0707672d3ba624d3"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"ChrisBAshton"}}