* 慕名而来玩玩 * 换格式 把webp格式的图片换成jpg了 似乎github那边的pr没办法预览webp * 更新两张新图 * 定期更新一下 * Update README.md * Create README.md with updates and learnings Added a README file with updates and personal reflections. * Add files via upload * 更新嘻嘻 * Initial plan * Add PR template, EXIF check workflow, and strip-exif workflow Co-authored-by: Yueosa <172176062+Yueosa@users.noreply.github.com> * Address code review: reduce exiftool timeout, improve error logging in strip workflow Co-authored-by: Yueosa <172176062+Yueosa@users.noreply.github.com> * Security: pin checkout to SHA, add env vars for shell safety, add security comments Co-authored-by: Yueosa <172176062+Yueosa@users.noreply.github.com> * Improve PR template with newcomer guidance, friendlier EXIF comment, add beginner guide, update README Co-authored-by: Yueosa <172176062+Yueosa@users.noreply.github.com> * Fix PR template links to use absolute GitHub URLs Co-authored-by: Yueosa <172176062+Yueosa@users.noreply.github.com> * 修改示例中的 ID 为我自己的ID * delete(action): 删除没必要的工作流 * fix(action): 删除对strip_exif工作流的描述 * docs(GUIDE): 为 fork, commit 等操作添加了简单说明 * fix(docs): OMG我是猪鼻, 我把仓库地址写错了X_X * fix: 被 copilot 鞭策了 * 删除拉取请求模板中的描述部分 * 补充推荐使用--depth的妙妙小提示 * - 补充删旧评论机制 - 移除不必要的权限 - 只在图片变更时触发 - 修复fork pr拿不到来源的bug * 优化拉取请求模板,增加新手指南的可折叠提示 * 更新 check_exif.yml:升级 actions/checkout 到 v5,优化 exiftool 安装逻辑,增强 PR 评论管理 * 到底要不要删掉旧评论呢(哭), Moemu大佬好像是没删的, 豪! 我也不删了! * 被删除的不必要的权限似乎是必要的 * 修一修代码格式, 压一压行数 * 修正评论格式 --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Yueosa <172176062+Yueosa@users.noreply.github.com>
7.0 KiB
🌟 新手指南 / Beginner Guide
欢迎来到 Dress 项目!这份指南将帮助你完成第一次 Pull Request(PR)。
Welcome to the Dress project! This guide will help you complete your first Pull Request (PR).
📋 提交流程概览 / Submission Workflow Overview
Fork 仓库 → 添加你的照片 → 提交 Commit → 发起 Pull Request → 等待审核合并
Fork repo → Add your photos → Commit → Open Pull Request → Wait for review & merge
第一步:Fork 仓库 / Step 1: Fork the Repository
Fork = 把别人的仓库「复制」一份到你自己的 GitHub 账号下,让你可以自由修改喵,不会影响原项目喵!
Fork = Creating your own copy of someone else's repository under your GitHub account, so you can freely make changes without affecting the original.
- 打开 Dress 仓库页面
- 点击页面右上角的 Fork 按钮
- 这会在你的 GitHub 账号下创建一份仓库副本
- Go to the Dress repository page
- Click the Fork button at the top right
- This creates a copy of the repository under your GitHub account
第二步:添加你的照片 / Step 2: Add Your Photos
Commit = 给你的修改拍一张「快照」,记录你改了什么内容,每次 Commit 都会生成一条历史记录喵!
Commit = Taking a "snapshot" of your changes, recording what you modified. Each commit creates a point in the project history.
方法 A:直接在 GitHub 网页上传(最简单)/ Method A: Upload via GitHub Web (Easiest)
- 进入你 Fork 后的仓库页面(
https://github.com/<你的用户名>/Dress) - 找到你 GitHub ID 首字母对应的文件夹(如 ID 为
Yueosa,则进入Y文件夹) - 点击 Add file → Create new file
- 在文件名栏输入
你的GitHubID/README.md(如Yueosa/README.md),这会自动创建文件夹 - 在文件中随意写一些内容(如自我介绍)
- 点击 Commit changes
- 再次点击 Add file → Upload files,将你的照片上传到刚创建的文件夹中
- 点击 Commit changes
- Go to your forked repository (
https://github.com/<your-username>/Dress) - Navigate to the folder matching the first letter of your GitHub ID (e.g.,
YforYueosa) - Click Add file → Create new file
- Type
YourGitHubID/README.md(e.g.,Yueosa/README.md) in the filename field — this auto-creates the folder - Write some content (e.g., a brief introduction)
- Click Commit changes
- Click Add file → Upload files again, and upload your photos into the folder you just created
- Click Commit changes
方法 B:使用 Git 命令行 / Method B: Using Git CLI
Clone = 把远程仓库下载到本地电脑。 Push = 把本地的 Commit 上传同步到远程仓库(你的 Fork)。
Clone = Downloading the remote repository to your local machine. Push = Uploading your local commits back to the remote repository (your Fork).
# 1. 克隆你 Fork 的仓库 / Clone your forked repository
# 💡 由于仓库 commit 历史较多,直接 clone 可能较慢。
# 推荐使用 --depth 1 仅拉取最近一次提交,速度更快喵!
# 💡 The repo has a large commit history, so a full clone may be slow.
# Consider using --depth 1 to only fetch the latest commit for a faster download!
git clone --depth 1 https://github.com/<你的用户名>/Dress.git
cd Dress
# 2. 创建你的文件夹并添加照片 / Create your folder and add photos
# 将 <首字母> 替换为你 GitHub ID 的首字母,<你的GitHubID> 替换为你的 GitHub ID
# Replace <FirstLetter> with the first letter of your GitHub ID
mkdir -p <首字母>/<你的GitHubID>
cp /path/to/your/photos/* <首字母>/<你的GitHubID>/
# 3. 提交更改 / Commit your changes
git add .
git commit -m "Add photos for <你的GitHubID>"
# 4. 推送到你的 Fork / Push to your fork
git push origin main
第三步:发起 Pull Request / Step 3: Open a Pull Request
Pull Request(PR) = 向原仓库的维护者提出申请:「我在我的 Fork 里做了一些修改,请把它们合并到原项目里吧喵!」
Pull Request (PR) = A request to the original repository's maintainers saying: "I've made some changes in my Fork — please merge them into the original project!"
- 回到你 Fork 的仓库页面
- 你会看到一个提示 "This branch is X commits ahead",点击 Contribute → Open pull request
- 填写 PR 模板中的描述和检查清单
- 点击 Create pull request
- Go back to your forked repository page
- You should see a prompt saying "This branch is X commits ahead" — click Contribute → Open pull request
- Fill in the description and checklist in the PR template
- Click Create pull request
第四步:等待审核 / Step 4: Wait for Review
提交 PR 后,自动化机器人会帮你检查:
- 📏 文件大小检查:图片是否在 1MB 以内
- 🔒 EXIF 信息检查:图片是否包含隐私元数据
如果检查未通过,机器人会留下评论告诉你如何修正。你可以按照提示修改后再次推送(push),PR 会自动更新。
维护者审核通过后,你的 PR 就会被合并。恭喜你完成了第一次开源贡献!🎉
After submitting the PR, automated bots will check:
- 📏 File size check: Are images under 1MB?
- 🔒 EXIF data check: Do images contain private metadata?
If any check fails, the bot will leave a comment explaining how to fix it. You can make changes and push again — the PR will update automatically.
Once a maintainer approves, your PR will be merged. Congratulations on your first open-source contribution! 🎉
⚠️ 提交前请注意 / Before You Submit
- 压缩图片 — 确保每张图片小于 1MB。可以使用 TinyPNG 等在线工具压缩。
- 移除 EXIF 信息 — 照片可能包含你的位置、设备等隐私信息。详见 CONTRIBUTING.md。
- 正确命名文件夹 — 使用你的 GitHub ID 命名,并放在对应首字母目录下。
- 原创图片 — 只提交你自己的照片,不接受盗图。
- Compress images — Make sure each image is under 1MB. Use tools like TinyPNG.
- Remove EXIF data — Photos may contain your location, device info, etc. See CONTRIBUTING.md.
- Name your folder correctly — Use your GitHub ID and place it under the matching alphabetical directory.
- Original images only — Only submit your own photos. Stolen images are not accepted.