
is a file that lists people who are significant authors of the project, such as the people who are legally related to the work.
AUTHORS File: AUTHORS or AUTHORS.txt or AUTHORS.md etc. is a file that lists people who have contributed to the repo. CONTRIBUTORS File: CONTRIBUTORS or CONTRIBUTORS.txt or CONTRIBUTORS.md etc. #Folders for folders factory software#
Version number increases, software updates, bug fixes… are examples of the file’s content.
is a file that describes what's happening in the repo.
CHANGELOG File: CHANGELOG or CHANGELOG.txt or CHANGELOG.md etc. Should contain scripts to automate tasks in the project, for example, build scripts, rename scripts. tools Folder: Convenience directory for your use. samples Folder: Providing “Hello World” & Co code that supports the documentation. res Folder: For all static resources in your project. dep Folder: This is the directory where all your dependencies should be stored. build Folder: This folder should contain all scripts related to build process (PowerShell, Docker compose…). config Folder: It should local configuration related to setup on local machine. test Folder: Unit tests, integration tests… go here.
src Folder: The source code folder! However, in languages that use headers (or if you have a framework for your application) don’t put those files in here. Code Factory Berlin: OpenSourceRepoTemplate on GitHubĪnd now let’s describe the structure: Basic Folder Structure