Skip to content

.github-publish-guide.md

Latest commit

 

History

History
259 lines (175 loc) · 5.44 KB

.github-publish-guide.md

File metadata and controls

259 lines (175 loc) · 5.44 KB
Raw

🚀 快速发布到GitHub指南

第一步：修改个人信息 ✏️

在发布前，请先修改README.md中的占位符信息。

方法一：使用命令行（推荐）

cd /Users/renmeng/work_space/chrome-extension/qnloft-qinglong-chrome-extension

# 替换GitHub用户名（将 YOUR_GITHUB_USERNAME 改为你的用户名）
sed -i '' 's/yourusername/YOUR_GITHUB_USERNAME/g' README.md

# 替换邮箱（将 YOUR_EMAIL 改为你的邮箱）
sed -i '' 's/your\.email@example\.com/YOUR_EMAIL/g' README.md

# 如果想修改仓库名（可选，默认是 qinglong-cookie-sync）
# sed -i '' 's/qinglong-cookie-sync/新仓库名/g' README.md

方法二：手动编辑

打开 README.md，搜索并替换以下内容：

  1. yourusername → 你的GitHub用户名
  2. your.email@example.com → 你的邮箱
  3. qinglong-cookie-sync → 你的仓库名（可选）

第二步：检查敏感信息 🔍

确认以下内容已处理：

✅ 截图中没有真实的URL、IP地址
✅ 截图中没有真实的Cookie值
✅ 代码中没有测试用的密钥
✅ 没有个人隐私信息

第三步：提交代码 📦

# 1. 查看当前状态
git status

# 2. 添加所有文件
git add .

# 3. 提交（使用规范的提交信息）
git commit -m "feat: 初始版本发布 v1.0.0

- 添加Cookie自动同步功能
- 添加多网站配置支持  
- 添加环境变量管理
- 添加同步日志查看
- 添加配置向导
- 优化界面和用户体验
- 添加完整文档和截图"

# 4. 查看提交历史
git log --oneline -5

第四步：创建GitHub仓库 🌐

在GitHub网站上操作：

  1. 访问 https://github.com/new

  2. 仓库设置：

    • Repository name: qnloft-qinglong-chrome-extension
    • Description: 🍪 自动同步网站Cookie到青龙面板的Chrome扩展，支持多网站配置和完整的环境变量管理
    • 选择 Public（公开）
    • ❌ 不要勾选任何"Initialize"选项

  3. 点击 "Create repository"

第五步：推送到GitHub 🚀

复制GitHub显示的命令，或使用以下命令：

# 添加远程仓库（替换为你的信息）
git remote add origin https://github.com/你的用户名/qnloft-qinglong-chrome-extension.git

# 推送到GitHub
git push -u origin main

# 如果推送失败，可能需要先拉取
# git pull origin main --allow-unrelated-histories
# git push -u origin main

第六步：完善仓库信息 ✨

1. 添加Topics标签

在仓库页面点击 ⚙️ Settings → General → 找到 Topics，添加：

  • chrome-extension
  • qinglong
  • cookie-sync
  • browser-extension
  • javascript
  • cookie-manager
  • automation

2. 设置About

在仓库首页右侧，点击 ⚙️ 设置：

  • Description: 🍪 自动同步网站Cookie到青龙面板的Chrome扩展
  • Website: https://qnloft.com/
  • ✅ 勾选 "Releases"
  • ✅ 勾选 "Packages"

3. 启用功能

在 Settings → General → Features：

  • ✅ Issues
  • ✅ Discussions（可选）
  • ✅ Projects（可选）

第七步：创建Release版本 📦

方法一：使用GitHub网站

  1. 进入仓库页面
  2. 点击右侧 Releases → Create a new release
  3. 填写信息：
    • Tag version: v1.0.0
    • Release title: v1.0.0 - 首次发布
    • Description: 复制CHANGELOG.md中的v1.0.0内容
  4. 点击 Publish release

方法二：使用命令行

# 创建标签
git tag -a v1.0.0 -m "Release v1.0.0 - 首次发布"

# 推送标签
git push origin v1.0.0

然后在GitHub网站上编辑Release说明。

第八步：宣传推广 📢

1. 在青柠炸机店发布

  • 撰写使用教程
  • 发布到官网博客
  • 分享安装和配置指南

2. 社区分享

  • 技术论坛
  • 相关QQ群/微信群
  • Reddit/V2EX等社区

3. 持续更新

  • 收集用户反馈
  • 修复bug
  • 添加新功能
  • 定期更新README

常见问题 ❓

Q: 推送失败，提示权限错误？

A: 需要配置GitHub认证：

# 方法1：使用Personal Access Token
# 1. 访问 https://github.com/settings/tokens
# 2. 生成新token，勾选 repo 权限
# 3. 使用token作为密码推送

# 方法2：使用SSH
# 1. 生成SSH密钥：ssh-keygen -t rsa -b 4096 -C "your.email@example.com"
# 2. 添加到GitHub：https://github.com/settings/keys
# 3. 修改远程URL：git remote set-url origin git@github.com:username/repo.git

Q: 想要修改已提交的内容？

A: 如果还没有推送到GitHub：

# 修改最后一次提交
git commit --amend

# 重置到上一个提交（保留更改）
git reset --soft HEAD~1

Q: 如何更新远程仓库？

A: 日常更新流程：

# 1. 修改代码...
# 2. 查看更改
git status
git diff

# 3. 添加更改
git add .

# 4. 提交
git commit -m "feat: 添加xxx功能"

# 5. 推送
git push

检查清单 ✅

发布前最后检查：

  • 已修改README中的所有占位符
  • 已检查所有截图，确保无敏感信息
  • 已测试扩展功能正常
  • 已添加LICENSE文件
  • 已创建CHANGELOG.md
  • 已完善.gitignore
  • 已提交所有更改
  • 已在GitHub创建仓库
  • 已推送代码到GitHub
  • 已添加Topics标签
  • 已创建Release版本
  • 已启用Issues功能

完成以上步骤后，你的项目就成功发布到GitHub了！🎉

如有问题，请访问：https://qnloft.com/ 寻求帮助。