{"action":"created","issue":{"url":"https://api.github.com/repos/mbedmicro/pyOCD/issues/184","labels_url":"https://api.github.com/repos/mbedmicro/pyOCD/issues/184/labels{/name}","comments_url":"https://api.github.com/repos/mbedmicro/pyOCD/issues/184/comments","events_url":"https://api.github.com/repos/mbedmicro/pyOCD/issues/184/events","html_url":"https://github.com/mbedmicro/pyOCD/issues/184","id":105040551,"number":184,"title":"pyOCD style guide and tools","user":{"login":"c1728p9","id":2916772,"avatar_url":"https://avatars.githubusercontent.com/u/2916772?v=3","gravatar_id":"","url":"https://api.github.com/users/c1728p9","html_url":"https://github.com/c1728p9","followers_url":"https://api.github.com/users/c1728p9/followers","following_url":"https://api.github.com/users/c1728p9/following{/other_user}","gists_url":"https://api.github.com/users/c1728p9/gists{/gist_id}","starred_url":"https://api.github.com/users/c1728p9/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/c1728p9/subscriptions","organizations_url":"https://api.github.com/users/c1728p9/orgs","repos_url":"https://api.github.com/users/c1728p9/repos","events_url":"https://api.github.com/users/c1728p9/events{/privacy}","received_events_url":"https://api.github.com/users/c1728p9/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/mbedmicro/pyOCD/labels/type:%20question","name":"type: question","color":"cc317c"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2015-09-05T18:06:44Z","updated_at":"2015-09-05T20:25:05Z","closed_at":null,"body":"To make contributions easier, pyOCD needs a recommended style guide/naming convention, along with tools to easily check these and auto formatting source.\r\n\r\nMy preference is that the code is compliant to pep8 where reasonable.  Contributors would be encouraged to follow the conventions, but would not be required to.  This could also be automated to post warnings on pull requests if the code has pep8 inconsistencies.\r\n\r\nDevelopment IDEs\r\n-Eclipse with pyDev - allows auto formatting, and highlighting of code that is non-pep8 compliant.  It also is able to catch errors, such as referencing variables that doesn't exist\r\n-pyCharm\r\n\r\nCode style checking tools:\r\n-pep8\r\n-pylint\r\n\r\nAuto formatting Tools\r\n-autopep8\r\n\r\n\r\nIf anyone has other ideas or preferences please respond to this issue."},"comment":{"url":"https://api.github.com/repos/mbedmicro/pyOCD/issues/comments/137992862","html_url":"https://github.com/mbedmicro/pyOCD/issues/184#issuecomment-137992862","issue_url":"https://api.github.com/repos/mbedmicro/pyOCD/issues/184","id":137992862,"user":{"login":"0xc0170","id":2963726,"avatar_url":"https://avatars.githubusercontent.com/u/2963726?v=3","gravatar_id":"","url":"https://api.github.com/users/0xc0170","html_url":"https://github.com/0xc0170","followers_url":"https://api.github.com/users/0xc0170/followers","following_url":"https://api.github.com/users/0xc0170/following{/other_user}","gists_url":"https://api.github.com/users/0xc0170/gists{/gist_id}","starred_url":"https://api.github.com/users/0xc0170/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/0xc0170/subscriptions","organizations_url":"https://api.github.com/users/0xc0170/orgs","repos_url":"https://api.github.com/users/0xc0170/repos","events_url":"https://api.github.com/users/0xc0170/events{/privacy}","received_events_url":"https://api.github.com/users/0xc0170/received_events","type":"User","site_admin":false},"created_at":"2015-09-05T20:25:05Z","updated_at":"2015-09-05T20:25:05Z","body":"Agree, pep8 would be a good start to at least format the current code."}}