这篇文章介绍怎么把本地 Python 项目用 Git 进行版本控制并推送到 GitHub
第一步:安装必要的工具
如果你还没有安装:
- 安装 Git:https://git-scm.com/
- 注册 GitHub 账号:https://github.com/
第二步:在项目目录初始化 Git
- 打开命令提示符或终端
- 进入你的项目目录:
bash
cd D:\workplace\TSC
- 初始化 Git 仓库:
bash
git init
- 配置全局用户名和邮箱:(替换为你的 GitHub 用户名和注册邮箱):
bash
git config --global user.name "你的GitHub用户名"
git config --global user.email "你的GitHub注册邮箱"
第三步:创建 .gitignore 文件
在项目根目录创建 .gitignore 文件,内容如下:
# Python 相关
__pycache__/
*.py[cod]
*$py.class
*.so
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
# Jupyter Notebook
.ipynb_checkpoints/
# 数据集和大型文件(不需要版本控制)
backups/
EMNIST/
FashionMNIST/
MNIST/
matchlayersfc/
# 环境相关
.env
.venv
venv/
ENV/
# IDE
.vscode/
.idea/
*.swp
*.swo
# 系统文件
.DS_Store
Thumbs.db
第四步:添加文件到 Git
- 添加所有文件到暂存区:
bash
git add .
- 如果你只想添加特定类型的文件,可以分别添加:
bash
git add *.py
git add *.ipynb
git add *.md
git add data_utils.py ft_devices.py helper.py models.py
第五步:提交更改
bash
git commit -m "初始提交:添加TSC项目文件,包括MNIST/EMNIST实验代码"
第六步:在 GitHub 创建远程仓库
- 登录 GitHub
- 点击右上角 "+" → "New repository"
- 填写仓库名称(如 "TSC-Project")
- 描述可选填
- 选择 Public 或 Private
- 不要初始化 README、.gitignore 或 license(因为本地已经有了)
- 点击 "Create repository"
第七步:连接本地和远程仓库
复制 GitHub 提供的命令,类似这样:
bash
git remote add origin https://github.com/你的用户名/TSC-Project.git
git branch -M main
git push -u origin main
第八步:推送代码到 GitHub
bash
git push -u origin main
后续开发工作流程
以后每次修改代码后,使用这个流程:
- 查看更改状态:
bash
git status
- 添加修改的文件:
bash
git add .
# 或者添加特定文件
git add 文件名.py
- 提交更改:
bash
git commit -m "描述你的修改内容"
- 推送到远程:
bash
git push
重要提醒
- 不要将大型数据集上传到 Git(已经在 .gitignore 中排除了)
- 定期提交,保持提交信息的清晰
- 如果有多人协作,记得先
git pull再开始工作 - 重要的模型文件或大型文件考虑使用 Git LFS
这样你的项目就在 Git 版本控制下了,并且同步到了 GitHub!