将Python Django项目上传至GitHub的专业规范咨询

1. 必须包含的文件夹/文件 #

• 项目根目录下的Django主配置文件夹（即包含settings.py、urls.py的目录，与manage.py同级）
• 你和朋友开发的所有自定义app文件夹（比如accounts/、portfolio/这类业务模块）
• static/和templates/文件夹（如果使用了自定义静态资源与模板）
• 核心入口文件manage.py

2. 哪些该忽略，哪些必须传？ #

• 绝对不要上传的内容：
  • django_env/：虚拟环境文件夹，里面的依赖包是本地环境专属，上传冗余且对他人无用
  • .idea/：PyCharm的个人IDE配置文件，属于本地开发环境信息，与项目本身无关
  • .DS_Store：Mac系统自动生成的隐藏文件，仅用于本地文件管理，无需上传
• 必须上传的文件：
  • .gitignore：Git的忽略规则配置文件，必须上传，它能确保所有人都不会误传上述无关文件

3. requirements.txt和README.md的位置 #

两个文件都放在项目根目录（与manage.py同级）：

• requirements.txt：记录项目所有依赖，他人克隆项目后，直接执行pip install -r requirements.txt即可搭建一致环境
• README.md：这是你的项目“门面”，对于求职作品集尤为重要，要写清项目定位、技术栈、本地运行步骤、功能亮点，甚至你负责的模块分工

专业上传的完整步骤 #

1. 初始化Git仓库：在项目根目录打开终端，执行git init
2. 配置.gitignore：新建.gitignore文件，写入以下规则（可按需调整）：

   # 虚拟环境
   django_env/
   venv/
   env/
   
   # IDE配置
   .idea/
   .vscode/
   
   # 系统文件
   .DS_Store
   Thumbs.db
   
   # Django本地文件
   __pycache__/
   *.pyc
   db.sqlite3
   media/
   

3. 生成依赖清单：激活虚拟环境后，执行pip freeze > requirements.txt，确保仅包含项目实际用到的依赖（避免混入系统全局依赖）
4. 完善README.md：重点突出求职相关内容，比如项目解决的问题、你运用的技术点、负责的核心模块，让面试官快速get你的能力
5. 提交代码：

   git add .
   git commit -m "Initial commit: 完成作品集项目核心功能开发"
   

6. 推送到GitHub：在GitHub新建空白仓库，复制仓库地址后执行：

   git remote add origin 你的仓库地址
   git push -u origin main
   

内容的提问来源于stack exchange，提问作者Hubert Rykała