GitHub 创建python项目（.gitignore LICENSE README.md...）的了解

最新推荐文章于 2025-03-23 14:54:19 发布

别动我名字

最新推荐文章于 2025-03-23 14:54:19 发布

阅读量1.7k

点赞数 1

分类专栏： python 基础

本文链接：https://blog.youkuaiyun.com/qq_39806105/article/details/93009943

版权

了解如何在GitHub上创建Python项目，包括必备的README.md（项目介绍和代码结构）、LICENSE（开放源代码许可协议）、.gitignore（忽略特定文件）和requirements.txt（记录依赖包版本）。.gitignore遵循原则，忽略操作系统生成文件、编译产物和敏感信息。requirements.txt用于记录项目依赖，便于环境复现。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Get started by creating a new file or uploading an existing file. We recommend every repository include a README, LICENSE, and .gitignore.
解释：
开始通过创建一个新文件或上传现有文件。我们建议每个存储库都包含README、LICENSE和.gitignore。

README.md

必要的项目介绍、使用及代码结构

使用markdown语法：参考https://www.jianshu.com/p/b03a8d7b1719

LICENSE

.gitignore

用于项目下的所有开发者都共享的，一套定义好的，忽略特殊文件规则。

Git忽略文件的原则：

忽略操作系统自动生成的文件，比如缩略图等；
忽略编译生成的中间文件、可执行文件等，也就是如果一个文件是通过另一个文件自动生成的，那自动生成的文件就没必要放进版本库，比如Java编译产生的.class文件；
忽略你自己的带有敏感信息的配置文件，比如存放口令的配置文件。

如下是一个合适python开发的规则：

# 忽略Windows自动在有图片的目录下生成隐藏的缩略图文件，如果有自定义目录，则忽略目录下的Desktop.ini文件:
Thumbs.

最低0.47元/天解锁文章