Repo Common Folders
This is a convention used to organize the contents of Listiary project repositories.
This is a list of some of the standard folders and files users may find in Listiary project repositories.
Most of these folder names and their general purposes are well known on GitHub and are used across many repositories.
Most of the files are very common across many repositories on GitHub as well, but some are our own implementation.
Standard repository folders
/assets
Files used by the project that are not source code, such as images, fonts, or other media.
/docs
Documentation and other files related to documenting the project.
The main documentation lives on the documentation website. This directory may contain a PDF version of the documentation and can also be used as a workspace for developing new documentation.
/release
Files prepared for distribution as part of a project release.
/src
The project’s source code.
/work
Files related to ongoing development that are not part of the project’s main source or release files.
Standard repository files
CHANGELOG.md
A changelog containing a record of changes made in each version of the software.
CODE_OF_CONDUCT.md
A document describing the code of conduct and expected behavior within the repository’s community.
CONTRIBUTING.md
A document describing the process and guidelines for contributing to the project.
LICENSE
The license under which the repository’s contents are distributed. Note that it intentionally lacks any file extension - this is the GitHub convention.
README.md
The standard readme file for the repository. Its contents are displayed on the repository’s home page.
REPOSITORY_LAYOUT.md
A document explaining the directory structure and organization of the repository.