Best Practices - UNGPhysics/welcome GitHub Wiki

  • Avoid creating similar copies of the same thing. For example, it is a bad practice to have a bunch of repositories like phys2212-harrison-spring2018, phys2212-harrison-fall2018, phys2212-harrison-spring2019, etc. Rather, have a single repository called phys2212-harrison that evolves with time. Git will preserve the repository's history and you can use tools like Tags, Branches, and Forks to help you stay organized.

  • Avoid putting binary files (especially large ones) in repositories when possible. For example, a LaTeX source is much better than a Word document or a pdf file. Images to be used in a document are generally unavoidable and are okay (but the resolution should be reasonable).