1. 创建新的 GitHub 仓库
- 登录 GitHub:访问 github.com 并登录你的账户。
- 新建仓库:
- 点击右上角
+
→New repository
。 - 填写仓库信息:
- Repository name:建议用论文标题缩写(如
paper-title-code
)。 - Description:简要描述(如 “Code for [论文标题]”)。
- Public/Private:选择
Public
(公开)。 - Initialize this repository with:勾选
Add a README file
(可选,但推荐)。 - Add .gitignore:选择编程语言(如 Python),自动过滤临时文件。
- Choose a license:选择开源协议(推荐学术代码使用 MIT 或 Apache 2.0)。
- Repository name:建议用论文标题缩写(如
- 点击
Create repository
。
- 点击右上角
2. 上传代码到仓库
方法 1:通过命令行(Git)
- 安装 Git(如未安装):
- 下载地址:git-scm.com
- 本地准备代码:
- 将代码文件整理到一个文件夹中,删除敏感数据或大文件(如数据集)。
- 执行命令:
# 进入代码目录 cd /path/to/your/code # 初始化本地仓库 git init # 关联远程仓库(替换为你的仓库URL) git remote add origin https://github.com/你的用户名/仓库名.git # 添加所有文件到暂存区 git add . # 提交代码(描述清晰) git commit -m "Initial commit: code for paper [标题]" # 推送代码到GitHub git push -u origin main
方法 2:直接拖拽上传(适合小项目)
- 进入仓库页面,点击
Add file
→Upload files
。 - 将本地代码文件夹拖拽到网页上传区域。
- 填写提交信息(如 “Initial upload”),点击
Commit changes
。
方法 3:使用 GitHub Desktop(图形化工具)
- 下载安装 GitHub Desktop。
- 登录后选择
File → Clone Repository
,选择刚创建的仓库。 - 将代码文件复制到本地仓库文件夹。
- 在 GitHub Desktop 中填写提交信息,点击
Commit to main
→Push origin
。
3. 完善仓库信息(增强可读性)
- 编辑 README.md:
- 说明代码用途、论文引用方式、运行环境依赖、安装步骤等。
- 使用 Markdown 添加示例、图表或论文链接(示例模板)。
- 添加 LICENSE 文件:
- 明确他人使用代码的权限(如 MIT 协议允许自由使用,但需保留版权声明)。
- 创建 Releases(可选):
- 为代码版本打标签(如
v1.0
),方便他人引用。
- 为代码版本打标签(如
4. 分享与维护
- 获取仓库链接:在仓库页面点击
Code
→ 复制 HTTPS/SSH URL。 - 在论文中注明:
- 添加类似语句:
“The code is available at: https://github.com/你的用户名/仓库名”
- 添加类似语句:
- 持续更新:
- 修复问题时通过
git commit
提交更新,保持代码与论文一致。
- 修复问题时通过
注意事项
- 敏感信息:确保代码中不包含密码、API密钥或私有数据。
- 大文件处理:避免上传超过 100MB 的文件(使用 Git LFS 或提供下载链接)。
- 依赖说明:在
requirements.txt
或environment.yml
中列出所有依赖库。
完成后,你的论文代码将对全球研究者可见,促进学术协作! 🚀