{"action":"created","issue":{"url":"https://api.github.com/repos/chrsmithdemos/google-styleguide/issues/36","labels_url":"https://api.github.com/repos/chrsmithdemos/google-styleguide/issues/36/labels{/name}","comments_url":"https://api.github.com/repos/chrsmithdemos/google-styleguide/issues/36/comments","events_url":"https://api.github.com/repos/chrsmithdemos/google-styleguide/issues/36/events","html_url":"https://github.com/chrsmithdemos/google-styleguide/issues/36","id":58991354,"number":36,"title":"styleguide maintenance","user":{"login":"GoogleCodeExporter","id":9614759,"avatar_url":"https://avatars.githubusercontent.com/u/9614759?v=3","gravatar_id":"","url":"https://api.github.com/users/GoogleCodeExporter","html_url":"https://github.com/GoogleCodeExporter","followers_url":"https://api.github.com/users/GoogleCodeExporter/followers","following_url":"https://api.github.com/users/GoogleCodeExporter/following{/other_user}","gists_url":"https://api.github.com/users/GoogleCodeExporter/gists{/gist_id}","starred_url":"https://api.github.com/users/GoogleCodeExporter/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/GoogleCodeExporter/subscriptions","organizations_url":"https://api.github.com/users/GoogleCodeExporter/orgs","repos_url":"https://api.github.com/users/GoogleCodeExporter/repos","events_url":"https://api.github.com/users/GoogleCodeExporter/events{/privacy}","received_events_url":"https://api.github.com/users/GoogleCodeExporter/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/chrsmithdemos/google-styleguide/labels/auto-migrated","name":"auto-migrated","color":"ededed"},{"url":"https://api.github.com/repos/chrsmithdemos/google-styleguide/labels/Priority-Medium","name":"Priority-Medium","color":"ededed"},{"url":"https://api.github.com/repos/chrsmithdemos/google-styleguide/labels/Type-Defect","name":"Type-Defect","color":"ededed"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-02-26T00:00:47Z","updated_at":"2015-02-26T00:00:47Z","closed_at":null,"body":"```\nHi,\n\nI see some problem with the maintenance of the styleguide as a project:\n\n- The project contains no README, LICENSE, CONTRIBUTING or CHANGELOG file (the \nproject homepage contains that information instead, of course, but that's not \nhow to do open-source, forks should have this information)\n- The project homepage does not link to this issue tracker\n- The homepage does not mention a maintainer, it is not clear at all who will \nrespond to issues, and who may decide about style changes.\n- some HTML sources have xml file ending\n- Eclipse/IntelliJ settings files in the repo are not linked from the homepage \nor any of the guides\n- The styleguides follow different conventions (xsl vs. css for styling, \ndifferent versioning schemes (last changed vs revision number))\n- cpplint.py would benefit from being hosted independently on github or similar \n(I forked to my personal github repo at https://github.com/tkruse/cpplint)\n- Maintenance of the guides would be more convenient if the HTML/XML sources \nwere written in a markdown dialect or reStructured text instead of xml. \nPossibly presenting via readthedocs would yield beautiful yet cheap results\n- The Common LISP Guide contains General guidelines regarding any project, not \njust LISP\n- code examples have no syntax highlighting\n- all language specific guides would do well to include further configuration \nfor the various existing static checker tools, such as checkstyle for Java or \npep8 for python etc. This would work better if there were more of a folder \nstructure.\n\nIn other words, the styleguide itself as an open-source project does not set a \ngreat example for how google should present open-source projects, IMO.\n\nCompare the effort that goes into this project with the effort that went into \nmaterial design guide: \nhttp://www.google.com/design/spec/material-design/introduction.html\n\nMaking the styleguide itself a model open-source project would easily be \nfeasible as Summer of Code project or similar.\n```\n\n-----\nOriginal issue reported on code.google.com by `tibokr...@googlemail.com` on 6 Jan 2015 at 5:59"},"comment":{"url":"https://api.github.com/repos/chrsmithdemos/google-styleguide/issues/comments/76089370","html_url":"https://github.com/chrsmithdemos/google-styleguide/issues/36#issuecomment-76089370","issue_url":"https://api.github.com/repos/chrsmithdemos/google-styleguide/issues/36","id":76089370,"user":{"login":"GoogleCodeExporter","id":9614759,"avatar_url":"https://avatars.githubusercontent.com/u/9614759?v=3","gravatar_id":"","url":"https://api.github.com/users/GoogleCodeExporter","html_url":"https://github.com/GoogleCodeExporter","followers_url":"https://api.github.com/users/GoogleCodeExporter/followers","following_url":"https://api.github.com/users/GoogleCodeExporter/following{/other_user}","gists_url":"https://api.github.com/users/GoogleCodeExporter/gists{/gist_id}","starred_url":"https://api.github.com/users/GoogleCodeExporter/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/GoogleCodeExporter/subscriptions","organizations_url":"https://api.github.com/users/GoogleCodeExporter/orgs","repos_url":"https://api.github.com/users/GoogleCodeExporter/repos","events_url":"https://api.github.com/users/GoogleCodeExporter/events{/privacy}","received_events_url":"https://api.github.com/users/GoogleCodeExporter/received_events","type":"User","site_admin":false},"created_at":"2015-02-26T00:00:47Z","updated_at":"2015-02-26T00:00:47Z","body":"```\nIn case translating html / xml to some other format seems too painful to \nanyone, it is not too difficult using pandoc. To demonstrate this, I forked the \nstyleguide here:\nhttps://github.com/tkruse/styleguide\n\nand added a Makefile that invokes pandoc on all files converting them \neventually to Asciidoc. Those rendered okay on github, as you can see by \nopening any *.asciidoc file. Looking at the Makefile you can see it's not 100% \nstraightforward, but really not bad at all.\n\nPandoc could also render to Markdown, rst, textile, wiki, etc.\nAnything would be better than the current mix of xml, html, xsl and javascript. \n \n\n(Also I noticed the file xmlstyle.html lacks opening <html><head><script> tags, \nand simlar closing </body> and </html> tags. More irony given this is an xml \nstyle guide). And it seems to have some encoding issues as well.\n```\n\n-----\nOriginal comment by `tibokr...@googlemail.com` on 7 Jan 2015 at 12:19"}}