{"action":"created","issue":{"url":"https://api.github.com/repos/programminghistorian/ph-submissions/issues/14","repository_url":"https://api.github.com/repos/programminghistorian/ph-submissions","labels_url":"https://api.github.com/repos/programminghistorian/ph-submissions/issues/14/labels{/name}","comments_url":"https://api.github.com/repos/programminghistorian/ph-submissions/issues/14/comments","events_url":"https://api.github.com/repos/programminghistorian/ph-submissions/issues/14/events","html_url":"https://github.com/programminghistorian/ph-submissions/issues/14","id":141568141,"number":14,"title":"Review Ticket for 'Getting Started with GitHub Desktop'","user":{"login":"wcaleb","id":1126864,"avatar_url":"https://avatars.githubusercontent.com/u/1126864?v=3","gravatar_id":"","url":"https://api.github.com/users/wcaleb","html_url":"https://github.com/wcaleb","followers_url":"https://api.github.com/users/wcaleb/followers","following_url":"https://api.github.com/users/wcaleb/following{/other_user}","gists_url":"https://api.github.com/users/wcaleb/gists{/gist_id}","starred_url":"https://api.github.com/users/wcaleb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wcaleb/subscriptions","organizations_url":"https://api.github.com/users/wcaleb/orgs","repos_url":"https://api.github.com/users/wcaleb/repos","events_url":"https://api.github.com/users/wcaleb/events{/privacy}","received_events_url":"https://api.github.com/users/wcaleb/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":{"login":"wcaleb","id":1126864,"avatar_url":"https://avatars.githubusercontent.com/u/1126864?v=3","gravatar_id":"","url":"https://api.github.com/users/wcaleb","html_url":"https://github.com/wcaleb","followers_url":"https://api.github.com/users/wcaleb/followers","following_url":"https://api.github.com/users/wcaleb/following{/other_user}","gists_url":"https://api.github.com/users/wcaleb/gists{/gist_id}","starred_url":"https://api.github.com/users/wcaleb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wcaleb/subscriptions","organizations_url":"https://api.github.com/users/wcaleb/orgs","repos_url":"https://api.github.com/users/wcaleb/repos","events_url":"https://api.github.com/users/wcaleb/events{/privacy}","received_events_url":"https://api.github.com/users/wcaleb/received_events","type":"User","site_admin":false},"milestone":null,"comments":6,"created_at":"2016-03-17T12:25:10Z","updated_at":"2016-04-08T16:25:54Z","closed_at":null,"body":"_The Programming Historian_ has received the following tutorial on '**An introduction to version control using GitHub Desktop**' by @davanstrien. This lesson is now under review and can be read at:\r\n\r\nhttp://programminghistorian.github.io/ph-submissions/lessons/getting-started-with-github-desktop\r\n\r\nI will act as editor for the review process. My role is to solicit two reviews from the community and to manage the discussions, which should be held here on this forum. I have already read through the lesson and provided feedback, to which the author has responded.\r\n\r\nMembers of the wider community are also invited to offer constructive feedback **which should post to this message thread**, but they are asked to first read our Reviewer Guidelines (http://programminghistorian.org/reviewer-guidelines) and to adhere to our anti-harassment policy (below). We ask that all reviews stop after the second formal review has been submitted so that the author can focus on any revisions. I will make an announcement on this thread when that has occurred.\r\n\r\nI will endeavor to keep the conversation open here on Github. If anyone feels the need to discuss anything privately, you are welcome to email me. You can always turn to @ianmilligan1 or @miriamposner if you feel there's a need for an ombudsperson to step in.\r\n\r\n**Anti-Harassment Policy**\r\n_\r\n\r\n> \r\n> This is a statement of the Programming Historian's principles and sets expectations for the tone and style of all correspondence between reviewers, authors, editors, and contributors to our public forums.\r\n> \r\n> The Programming Historian is dedicated to providing an open scholarly environment that offers community participants the freedom to thoroughly scrutize ideas, to ask questions, make suggestions, or to requests for clarification, but also provides a harassment-free space for all contributors to the project, regardless of gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, age or religion, or technical experience. We do not tolerate harassment or ad hominem attacks of community participants in any form. Participants violating these rules may be expelled from the community at the discretion of the editorial board. If anyone witnesses or feels they have been the victim of the above described activity, please contact our ombudspersons (Ian Milligan or Miriam Posner - http://programminghistorian.org/project-team). Thank you for helping us to create a safe space.\r\n\r\n_"},"comment":{"url":"https://api.github.com/repos/programminghistorian/ph-submissions/issues/comments/207502010","html_url":"https://github.com/programminghistorian/ph-submissions/issues/14#issuecomment-207502010","issue_url":"https://api.github.com/repos/programminghistorian/ph-submissions/issues/14","id":207502010,"user":{"login":"lms4w","id":8522361,"avatar_url":"https://avatars.githubusercontent.com/u/8522361?v=3","gravatar_id":"","url":"https://api.github.com/users/lms4w","html_url":"https://github.com/lms4w","followers_url":"https://api.github.com/users/lms4w/followers","following_url":"https://api.github.com/users/lms4w/following{/other_user}","gists_url":"https://api.github.com/users/lms4w/gists{/gist_id}","starred_url":"https://api.github.com/users/lms4w/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lms4w/subscriptions","organizations_url":"https://api.github.com/users/lms4w/orgs","repos_url":"https://api.github.com/users/lms4w/repos","events_url":"https://api.github.com/users/lms4w/events{/privacy}","received_events_url":"https://api.github.com/users/lms4w/received_events","type":"User","site_admin":false},"created_at":"2016-04-08T16:25:53Z","updated_at":"2016-04-08T16:25:53Z","body":"Thanks for this clear, helpful tutorial. As a novice GitHub user, I especially appreciate how clearly you explain the advantages of versioning and what \"commit\" entails--well done! The lesson is well-organized and approachable.\r\n\r\nLet me offer some suggestions, most of which are pretty specific.\r\n\r\n**Questions and suggestions:**\r\n\r\n* You might want to mention that students and researchers are eligible to receive free GitHub repositories: https://education.github.com/pack and https://github.com/blog/1840-improving-github-for-science\r\n\r\n* Consider presenting a few examples of how GitHub used for academic writing projects so that readers have models to explore. When is GitHub a good tool to use, and when is it not? (As opposed to, say, versioning available through services like Box or wikis.)\r\n\r\n* Briefly explain what distinguishes Git as an approach to version control (e.g. Git's distributed approach).\r\n\r\n* I'd be interested in learning more about how GitHub can be used to \"contribute and draw upon other projects.\" Would a section on pull and merge requests fit into this lesson, or do you envision a future lesson on this topic? \r\n\r\n* I suspect that one concern of novice GitHub users is making files public prematurely. How can one prevent this--by not syncing? \r\n\r\n* Is there any difference between how GitHub is used for writing projects and how GitHub is employed for coding?\r\n\r\n* How do we indicate which versions of files to version control in GitHub Desktop? I'm assuming it's through committing changes, but that can be made clear earlier.\r\n\r\n* I think you need to explain the term \"master,\" so the user knows what it means to \"Commit to master.\" \r\n\r\n* I appreciate the emphasis on the need to provide clear commit messages. As @ezmiller suggested, it would be helpful to see some principles for documenting commits. It might also be useful to provide a few models. Folks familiar with wikis may find the practice of summarizing changes when saving on a wiki a useful analogy.\r\n\r\n* Are there any suggestions for organizing and describing files in GitHub?\r\n\r\n* When you say \"To quickly view your repository online you can use the repository menu,\" make specific that the user should select \"View on GitHub.\"\r\n\r\n* The \"Publishing a repository\" screenshot may be confusing as it seems that you have a paid account and thus can keep code private. Perhaps use a screenshot from the free version or explain that you have the paid plan?\r\n\r\n* I think it might be helpful to briefly explain the key concepts such as \"repository,\" \"push,\" \"pull,\" \"fork,\" \"branch,\" and \"sync,\" as these terms tend to confuse newcomers. Alternatively, you could let readers know that these concepts will be discussed in future lessons or point them to a glossary.\r\n\r\n* How does GitHub reconcile conflicts between the local and web-based repositories?\r\n\r\n* What do I lose if I use GitHub Desktop instead of the command-line or web interface? What do I gain?\r\n\r\n* A brief explanation of Raw, Blame and History might be useful.\r\n\r\n* It might be helpful to explain the basic interface in both GitHub Desktop and the web version; I found helpful the schematic of the web interface available here http://blog.udacity.com/2015/06/a-beginners-git-github-tutorial.html  You might explain that the comparison graph under the Sync button allows you to scroll through the history of commits. \r\n\r\n* How can you roll back to earlier versions of a document?\r\n\r\n* It might be helpful to point to other ways you can use GitHub, e.g. for collaboration.\r\n\r\n* Should you discuss README.md files?\r\n\r\n* I think the \"Other Resources\" section might be fleshed out a bit. Consider adding:\r\n\r\n\t* https://desktop.github.com/\r\n\t* http://chronicle.com/blogs/profhacker/tag/github\r\n\t* https://www.git-tower.com/learn/git/ebook/en/command-line/appendix/best-practices\r\n\t* https://help.github.com/articles/github-glossary/\r\n\r\n**Mechanical errors**\r\n\r\n* The entire lesson could use a round of proofreading.\r\n* What is Git and GitHub? --> What are Git and GitHub?\r\n* Firstly (in \"What is Version Control and Why Use It?\") implies that there will be a \"second.\"\r\n* I'd suggest using \"while\" instead of \"whilst,\" since it is less formal.\r\n* Make sure that the H in GitHub is consistently capitalized.\r\n* Use a dash rather than a hyphen (-).\r\n* integrates it’s --> integrates its \r\n* straight forward --> straightforward.\r\n* \"using the push and pull commands use on the command line.\" Should that be \"used\"?\r\n* re-enforcing--> reinforcing\r\n* Pay attention to comma errors throughout. For example: \r\n\r\n- how to implement version control using ‘GitHub Desktop**,**’ a Graphical User Interface for GitHub.\r\n\r\n- Although GitHub’s focus is primarily on source code**,** other projects,\r\n\r\n**Overall**\r\n\r\nOn the whole, this is a readable, straightforward and helpful tutorial. Thanks!\r\n\r\nI plan to use parts of this tutorial in an Intro to GitHub workshop I'm doing on Monday. I'll let you know how it goes. "}}