{"action":"created","issue":{"url":"https://api.github.com/repos/mk270/whitakers-words/issues/27","labels_url":"https://api.github.com/repos/mk270/whitakers-words/issues/27/labels{/name}","comments_url":"https://api.github.com/repos/mk270/whitakers-words/issues/27/comments","events_url":"https://api.github.com/repos/mk270/whitakers-words/issues/27/events","html_url":"https://github.com/mk270/whitakers-words/issues/27","id":94504966,"number":27,"title":"Style and quality changes that need to be done","user":{"login":"darkestkhan","id":278553,"avatar_url":"https://avatars.githubusercontent.com/u/278553?v=3","gravatar_id":"","url":"https://api.github.com/users/darkestkhan","html_url":"https://github.com/darkestkhan","followers_url":"https://api.github.com/users/darkestkhan/followers","following_url":"https://api.github.com/users/darkestkhan/following{/other_user}","gists_url":"https://api.github.com/users/darkestkhan/gists{/gist_id}","starred_url":"https://api.github.com/users/darkestkhan/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/darkestkhan/subscriptions","organizations_url":"https://api.github.com/users/darkestkhan/orgs","repos_url":"https://api.github.com/users/darkestkhan/repos","events_url":"https://api.github.com/users/darkestkhan/events{/privacy}","received_events_url":"https://api.github.com/users/darkestkhan/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/mk270/whitakers-words/labels/technical%20debt","name":"technical debt","color":"5319e7"}],"state":"open","locked":false,"assignee":null,"milestone":{"url":"https://api.github.com/repos/mk270/whitakers-words/milestones/1","html_url":"https://github.com/mk270/whitakers-words/milestones/v1.98","labels_url":"https://api.github.com/repos/mk270/whitakers-words/milestones/1/labels","id":1203919,"number":1,"title":"v1.98","description":"This version will establish the process of releasing binary versions of the continuing fork of WORDS, whose last binary release was almost 10 years ago. The targets remain legally redistributable command-line executables for Windows, MacOS and Linux, and a source code release appropriate for a developer to install the build-time dependencies and build the executables in two or three minutes.\r\n\r\nThe small number of bugs uncovered in the existing versions will have been fixed; there won't be substantive features added.\r\n\r\nThe user documentation will match the programme.\r\n\r\nThe code will be cleaned up, comments updated / removed / added, and the overall structure of the code documented.","creator":{"login":"mk270","id":923403,"avatar_url":"https://avatars.githubusercontent.com/u/923403?v=3","gravatar_id":"","url":"https://api.github.com/users/mk270","html_url":"https://github.com/mk270","followers_url":"https://api.github.com/users/mk270/followers","following_url":"https://api.github.com/users/mk270/following{/other_user}","gists_url":"https://api.github.com/users/mk270/gists{/gist_id}","starred_url":"https://api.github.com/users/mk270/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mk270/subscriptions","organizations_url":"https://api.github.com/users/mk270/orgs","repos_url":"https://api.github.com/users/mk270/repos","events_url":"https://api.github.com/users/mk270/events{/privacy}","received_events_url":"https://api.github.com/users/mk270/received_events","type":"User","site_admin":false},"open_issues":6,"closed_issues":0,"state":"open","created_at":"2015-07-12T14:07:43Z","updated_at":"2015-07-12T15:41:10Z","due_on":null,"closed_at":null},"comments":2,"created_at":"2015-07-11T20:24:04Z","updated_at":"2015-07-14T08:27:04Z","closed_at":null,"body":"I will list all style changes that need to be done for style changes to be completed:\r\n- all names (especially public ones) shall¹ use Ada naming convention [easy but tedious] ²\r\n- ~~there shall spaces between binary operators and on left side of left parenthesis (unless it is preceded by apostrophe) [easy but tedious] ³~~\r\n- ~~there shall be no lines longer than 80 columns~~\r\n- all identifiers shall be as self-documenting as reasonably possible (s, ss, ssa? wtf does this even mean?) [one caveat - beside capitalization - don't change values in enumerations]\r\n\r\nAlso try to use FIXME, TODO and NOTE for (respectively) comments of bugs/problems, things that have to be done, description of non-obvious behavior, as they are easy to search for (with grep for example)\r\n\r\n¹ used shall as 'should' is too permissive\r\n² for interested: https://en.wikibooks.org/wiki/Ada_Style_Guide is commonly used quality and style guide for Ada, together with some examples and rationales behind style rules\r\n"},"comment":{"url":"https://api.github.com/repos/mk270/whitakers-words/issues/comments/121165426","html_url":"https://github.com/mk270/whitakers-words/issues/27#issuecomment-121165426","issue_url":"https://api.github.com/repos/mk270/whitakers-words/issues/27","id":121165426,"user":{"login":"darkestkhan","id":278553,"avatar_url":"https://avatars.githubusercontent.com/u/278553?v=3","gravatar_id":"","url":"https://api.github.com/users/darkestkhan","html_url":"https://github.com/darkestkhan","followers_url":"https://api.github.com/users/darkestkhan/followers","following_url":"https://api.github.com/users/darkestkhan/following{/other_user}","gists_url":"https://api.github.com/users/darkestkhan/gists{/gist_id}","starred_url":"https://api.github.com/users/darkestkhan/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/darkestkhan/subscriptions","organizations_url":"https://api.github.com/users/darkestkhan/orgs","repos_url":"https://api.github.com/users/darkestkhan/repos","events_url":"https://api.github.com/users/darkestkhan/events{/privacy}","received_events_url":"https://api.github.com/users/darkestkhan/received_events","type":"User","site_admin":false},"created_at":"2015-07-14T08:27:04Z","updated_at":"2015-07-14T08:27:04Z","body":"Good work. Really. I'm still working on that Inflections_Package (now mostly separating IO package bodies, making state more local, identifiers more self-documenting etc.)"}}