https://workyoucanexplain.com/tags/github/ Recent content in GitHub on Work You Can Explain Hugo en-US Copyright © Work You Can Explain Fri, 24 Jul 2026 00:00:00 -0500 https://workyoucanexplain.com/posts/a-project-readme-that-lets-someone-else-succeed/ Fri, 24 Jul 2026 00:00:00 -0500 https://workyoucanexplain.com/posts/a-project-readme-that-lets-someone-else-succeed/ <p>A README succeeds when another person can understand the project and reproduce its expected result without reconstructing your memory. State what the project does, what it requires, how to install, run, test, and verify it, and where to get help.</p> <h2 id="write-for-a-defined-reader">Write for a defined reader</h2> <p>Name the reader and starting state:</p> <blockquote> <p>These instructions are for a CS 101 student with Git and Python 3.13 installed who has cloned the repository but has not created the environment.</p> https://workyoucanexplain.com/posts/github-is-more-than-online-storage/ Fri, 24 Jul 2026 00:00:00 -0500 https://workyoucanexplain.com/posts/github-is-more-than-online-storage/ <p>GitHub can store a remote copy of a Git repository, but its larger role is collaboration around that repository. It adds access controls, issues, pull requests, review, automation, releases, and project presentation.</p> <h2 id="separate-git-from-github">Separate Git from GitHub</h2> <p>Git records repository history locally. GitHub hosts repositories and services around them. A remote is a named location used to exchange repository data; it is not the only valid copy and does not replace a tested backup.</p>