Do you know how to structure a project for GitHub?
Updated by Brady Stroud [SSW] 1 year ago. See history
123
<introEmbed
body={<>
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.
</>}
/>
❌ Figure: Bad example – The folder containing the source code is called ‘trunk’ rather than ‘src’ + there is no 'docs' folder containing the important documents
✅ Figure: Good example - All documentation is in the ‘docs’ folder, samples are in the ‘samples’ folder, and all the source code is under ‘src’
Categories
Acknowledgements
Related rules
Need help?
SSW Consulting has over 30 years of experience developing awesome software solutions.