{"action":"created","issue":{"url":"https://api.github.com/repos/OCA/maintainer-tools/issues/238","repository_url":"https://api.github.com/repos/OCA/maintainer-tools","labels_url":"https://api.github.com/repos/OCA/maintainer-tools/issues/238/labels{/name}","comments_url":"https://api.github.com/repos/OCA/maintainer-tools/issues/238/comments","events_url":"https://api.github.com/repos/OCA/maintainer-tools/issues/238/events","html_url":"https://github.com/OCA/maintainer-tools/issues/238","id":188920203,"number":238,"title":"README.rst maintainability","user":{"login":"bealdav","id":1853434,"avatar_url":"https://avatars.githubusercontent.com/u/1853434?v=3","gravatar_id":"","url":"https://api.github.com/users/bealdav","html_url":"https://github.com/bealdav","followers_url":"https://api.github.com/users/bealdav/followers","following_url":"https://api.github.com/users/bealdav/following{/other_user}","gists_url":"https://api.github.com/users/bealdav/gists{/gist_id}","starred_url":"https://api.github.com/users/bealdav/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bealdav/subscriptions","organizations_url":"https://api.github.com/users/bealdav/orgs","repos_url":"https://api.github.com/users/bealdav/repos","events_url":"https://api.github.com/users/bealdav/events{/privacy}","received_events_url":"https://api.github.com/users/bealdav/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":13,"created_at":"2016-11-12T16:25:02Z","updated_at":"2016-11-21T11:52:53Z","closed_at":null,"body":"### Milestone (Odoo version)\r\n- at least from v10\r\n\r\n### Module(s)\r\n- all modules\r\n\r\n### Steps to reproduce\r\n1. Write README.rst according to template\r\n2. all README looks like template at the time of the merge, not last template \r\n\r\n### Current behavior\r\nREADME.rst is statically generated and is never up to date. Painful / frustrated for readers/reviewers/developers (waste of time)\r\nPersonally I limit module contributions to oca because of that. Create a module with README template is ~ easy but not maintain it.\r\n\r\n### Expected behavior\r\n- README.rst  could be dynamically generated without boring task (like find the id of the repository of my module, etc)\r\n- [EDIT] it could be the beginning of new features to expose our modules: we could also generate like https://github.com/odoo/odoo/blob/10.0/addons/sale/static/description/index.html dynamically or other template for future OCA maket place\r\n\r\n#### How \r\n- README is a mix of static content (or depending on branch name/milestone) and specific content\r\n- We could automate merge of these data.\r\n- By add some keys to \\_\\_manifest\\_\\_.py for specific content: usage, configuration, roadmap, issues, etc.\r\n- script update README content periodically\r\n\r\nWhat do you think ?"},"comment":{"url":"https://api.github.com/repos/OCA/maintainer-tools/issues/comments/261917233","html_url":"https://github.com/OCA/maintainer-tools/issues/238#issuecomment-261917233","issue_url":"https://api.github.com/repos/OCA/maintainer-tools/issues/238","id":261917233,"user":{"login":"lmignon","id":544090,"avatar_url":"https://avatars.githubusercontent.com/u/544090?v=3","gravatar_id":"","url":"https://api.github.com/users/lmignon","html_url":"https://github.com/lmignon","followers_url":"https://api.github.com/users/lmignon/followers","following_url":"https://api.github.com/users/lmignon/following{/other_user}","gists_url":"https://api.github.com/users/lmignon/gists{/gist_id}","starred_url":"https://api.github.com/users/lmignon/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lmignon/subscriptions","organizations_url":"https://api.github.com/users/lmignon/orgs","repos_url":"https://api.github.com/users/lmignon/repos","events_url":"https://api.github.com/users/lmignon/events{/privacy}","received_events_url":"https://api.github.com/users/lmignon/received_events","type":"User","site_admin":false},"created_at":"2016-11-21T11:52:53Z","updated_at":"2016-11-21T11:52:53Z","body":":+1: to autogenerate README.rst"}}
{"actor":{"display_login":"lmignon"}}