diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..d6a3bbefae2309c220637f254d0d210268576e65 --- /dev/null +++ b/README.en.md @@ -0,0 +1,36 @@ +The `.gitignore` file is used to specify files and directories that should be ignored by the Git version control system. The following is a common `.gitignore` configuration example, which can be adjusted according to the specific needs of the project: + +``` +# Ignore all log files +*.log + +# Ignore all build output directories +/build/ +/dist/ + +# Ignore all dependency directories +/node_modules/ +/vendor/ + +# Ignore environment variable files +.env +.env.local + +# Ignore operating system generated files +.DS_Store +Thumbs.db + +# Ignore editor-specific files +.idea/ +.vscode/ +``` + +### Explanation: +- `*.log`: Ignores all log files. +- `/build/` and `/dist/`: These directories are commonly used to store built files, which do not need to be committed to version control. +- `/node_modules/` and `/vendor/`: These directories store project dependencies, which can be installed using package managers (e.g., npm, composer). +- `.env` and `.env.local`: Environment variable configuration files, which often contain sensitive information and should not be committed to version control. +- `.DS_Store` and `Thumbs.db`: Files generated by the operating system to store folder custom attributes, which have no impact on project development. +- `.idea/` and `.vscode/`: Configuration files generated by IDEs (e.g., IntelliJ IDEA, Visual Studio Code), which are typically user-specific and do not need to be shared. + +Please adjust the contents of the `.gitignore` file according to your project's actual needs to ensure that unnecessary files are not committed to the repository. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..cb2b7037f133ebbbde9c1219104af3880c21de4e --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +.gitignore文件用于指定Git版本控制系统应该忽略的文件和目录。以下是一个常见的.gitignore配置示例,可以根据项目的具体需求进行调整: + +``` +# 忽略所有日志文件 +*.log + +# 忽略所有构建输出目录 +/build/ +/dist/ + +# 忽略所有依赖项目录 +/node_modules/ +/vendor/ + +# 忽略环境变量文件 +.env +.env.local + +# 忽略操作系统生成的文件 +.DS_Store +Thumbs.db + +# 忽略编辑器特定文件 +.idea/ +.vscode/ +``` + +### 说明: +- `*.log`:忽略所有日志文件。 +- `/build/` 和 `/dist/`:通常用于存放构建后的文件,这些文件不需要提交到版本控制中。 +- `/node_modules/` 和 `/vendor/`:存放项目依赖,这些依赖可以通过包管理工具(如npm、composer等)安装。 +- `.env` 和 `.env.local`:环境变量配置文件,通常包含敏感信息,不应提交到版本控制中。 +- `.DS_Store` 和 `Thumbs.db`:操作系统生成的文件,用于存储文件夹的自定义属性,这些文件对项目开发没有影响。 +- `.idea/` 和 `.vscode/`:IDE(如IntelliJ IDEA、Visual Studio Code)生成的配置文件,这些文件通常是用户特定的,不需要共享。 + +请根据项目的实际需求调整`.gitignore`文件的内容,以确保不必要的文件不会被提交到版本库中。 \ No newline at end of file