Creating Code Repositories

Warehouse naming convention

Create a code repository named HelloShop on Github. Regarding the naming convention of the code repository, use the SnakeCaseLower nomenclature.

Warehouse folder structure

Create a folder named src in the repository to store the source code.

Documentation

Create a file named README.md in the warehouse to store the warehouse documentation. Of course, each folder should have a documentation if possible.

ignore file

The function of the gitignore file is to specify files that do not need to be submitted to the code repository, such as compiled files, log files, etc.

https://github.com/github/gitignore/blob/main/VisualStudio.gitignore

properties file

The function of the gitattributes file is to specify the attributes of the file, such as the newline character of the file, the encoding of the file, etc.

Directory structure

assets Static resources, including pictures, icons, videos, audios, etc.

build Build scripts, including compilation scripts, packaging scripts, release scripts, etc.

docs Related documents, including design documents, architecture documents, development documents, deployment documents, etc. `

samples Demonstration examples, including code examples, configuration examples, data examples, document examples, etc.

src Source code, including source code, configuration files, resource files, script files, etc.

tests Test code, including unit testing, integration testing, end-to-end testing, etc.

tools Tools used by the project.

Repository Branches

Repository branches are used to manage versions of the repository, such as master, develop, release, hotfix, feature, etc.

Repository Labels

Warehouse tags are used to mark the version of the warehouse, such as v1.0.0, v1.0.1, v1.1.0, v2.0.0, etc.