Do you know how to structure a project for GitHub?

Last updated by Brady Stroud [SSW] about 1 month ago.See history

It is important when working in multiple projects to ensure consistent practices.

Structuring your repositories consistently makes your project feel professional, and makes it easier to work with as it is predictable.

structure github bad
Figure: Bad example – The folder containing the source code is called ‘trunk’ rather than ‘src’ + there is no 'docs' folder containing the important documents

structure github good
Figure: Good example - All documentation is in the ‘docs’ folder, samples are in the ‘samples’ folder, and all the source code is under ‘src’

Adam Stephensen
Ben Cull
We open source. Powered by GitHub