{"action":"created","issue":{"url":"https://api.github.com/repos/freedomofpress/securedrop/issues/340","repository_url":"https://api.github.com/repos/freedomofpress/securedrop","labels_url":"https://api.github.com/repos/freedomofpress/securedrop/issues/340/labels{/name}","comments_url":"https://api.github.com/repos/freedomofpress/securedrop/issues/340/comments","events_url":"https://api.github.com/repos/freedomofpress/securedrop/issues/340/events","html_url":"https://github.com/freedomofpress/securedrop/issues/340","id":30311579,"number":340,"title":"Better developer documentation","user":{"login":"micahflee","id":156128,"avatar_url":"https://avatars.githubusercontent.com/u/156128?v=3","gravatar_id":"","url":"https://api.github.com/users/micahflee","html_url":"https://github.com/micahflee","followers_url":"https://api.github.com/users/micahflee/followers","following_url":"https://api.github.com/users/micahflee/following{/other_user}","gists_url":"https://api.github.com/users/micahflee/gists{/gist_id}","starred_url":"https://api.github.com/users/micahflee/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/micahflee/subscriptions","organizations_url":"https://api.github.com/users/micahflee/orgs","repos_url":"https://api.github.com/users/micahflee/repos","events_url":"https://api.github.com/users/micahflee/events{/privacy}","received_events_url":"https://api.github.com/users/micahflee/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/freedomofpress/securedrop/labels/feature","name":"feature","color":"fbca04"}],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":3,"created_at":"2014-03-27T15:31:23Z","updated_at":"2016-08-23T10:07:06Z","closed_at":"2016-08-23T10:07:06Z","body":"I think we should link to HACKING.md directly from README.md, and improve HACKING.md to include a lot more useful information. Right now it just tells you how to get started with vagrant, but I think it should also include:\r\n\r\n* Information about the securedrop-dev mailing list and IRC channel\r\n* How is git repo's directory structure organized? \r\n* How we use git. Why do you start in the develop branch after a git clone? How are the branches organized? Do we use git-flow, and if so how?\r\n* What is the proper way to make a pull request?\r\n\r\nI actually don't know the answers to all of these questions, so I can't volunteer to do this."},"comment":{"url":"https://api.github.com/repos/freedomofpress/securedrop/issues/comments/241686098","html_url":"https://github.com/freedomofpress/securedrop/issues/340#issuecomment-241686098","issue_url":"https://api.github.com/repos/freedomofpress/securedrop/issues/340","id":241686098,"user":{"login":"conorsch","id":657862,"avatar_url":"https://avatars.githubusercontent.com/u/657862?v=3","gravatar_id":"","url":"https://api.github.com/users/conorsch","html_url":"https://github.com/conorsch","followers_url":"https://api.github.com/users/conorsch/followers","following_url":"https://api.github.com/users/conorsch/following{/other_user}","gists_url":"https://api.github.com/users/conorsch/gists{/gist_id}","starred_url":"https://api.github.com/users/conorsch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/conorsch/subscriptions","organizations_url":"https://api.github.com/users/conorsch/orgs","repos_url":"https://api.github.com/users/conorsch/repos","events_url":"https://api.github.com/users/conorsch/events{/privacy}","received_events_url":"https://api.github.com/users/conorsch/received_events","type":"User","site_admin":false},"created_at":"2016-08-23T10:07:06Z","updated_at":"2016-08-23T10:07:06Z","body":"> Development environment setup is explained in docs/develop.md\r\n\r\nDeveloper documentation is now hosted in the ReadTheDocs setup: https://docs.securedrop.org/en/latest/development/getting_started.html and addresses the original concerns of this issue. Ongoing improvements to the developer docs are tracked in #1208, which supersedes this issue, so closing."}}
{"actor":{"display_login":"conorsch"}}