{"action":"closed","issue":{"url":"https://api.github.com/repos/Financial-Times/ft-origami/issues/387","labels_url":"https://api.github.com/repos/Financial-Times/ft-origami/issues/387/labels{/name}","comments_url":"https://api.github.com/repos/Financial-Times/ft-origami/issues/387/comments","events_url":"https://api.github.com/repos/Financial-Times/ft-origami/issues/387/events","html_url":"https://github.com/Financial-Times/ft-origami/issues/387","id":96273385,"number":387,"title":"Record documentation best practices in the module spec","user":{"login":"triblondon","id":1735391,"avatar_url":"https://avatars.githubusercontent.com/u/1735391?v=3","gravatar_id":"","url":"https://api.github.com/users/triblondon","html_url":"https://github.com/triblondon","followers_url":"https://api.github.com/users/triblondon/followers","following_url":"https://api.github.com/users/triblondon/following{/other_user}","gists_url":"https://api.github.com/users/triblondon/gists{/gist_id}","starred_url":"https://api.github.com/users/triblondon/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/triblondon/subscriptions","organizations_url":"https://api.github.com/users/triblondon/orgs","repos_url":"https://api.github.com/users/triblondon/repos","events_url":"https://api.github.com/users/triblondon/events{/privacy}","received_events_url":"https://api.github.com/users/triblondon/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":{"login":"triblondon","id":1735391,"avatar_url":"https://avatars.githubusercontent.com/u/1735391?v=3","gravatar_id":"","url":"https://api.github.com/users/triblondon","html_url":"https://github.com/triblondon","followers_url":"https://api.github.com/users/triblondon/followers","following_url":"https://api.github.com/users/triblondon/following{/other_user}","gists_url":"https://api.github.com/users/triblondon/gists{/gist_id}","starred_url":"https://api.github.com/users/triblondon/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/triblondon/subscriptions","organizations_url":"https://api.github.com/users/triblondon/orgs","repos_url":"https://api.github.com/users/triblondon/repos","events_url":"https://api.github.com/users/triblondon/events{/privacy}","received_events_url":"https://api.github.com/users/triblondon/received_events","type":"User","site_admin":false},"milestone":null,"comments":0,"created_at":"2015-07-21T09:40:47Z","updated_at":"2015-07-27T17:10:06Z","closed_at":"2015-07-27T17:10:06Z","body":"* Document code using SASSDoc and JSDoc\r\n* Write a README\r\n* Include a single-line description of what the module does\r\n* If repo is in Github, set it's home page URL to the module's page on the registry\r\n* Do not include standard info in the README which would apply equally to any other spec-compliant module\r\n* Include a usage example targeted at the most common use case\r\n* Do not include a full method or function reference unless it's not possible to cover that using JSDoc/SASSdoc.  Instead, if needed point the reader to the registry.\r\n* Include the licence, which should conform to the Open source release policy"}}