How to contribute
1. 同步(本地)
每次干活前,先回家(回到主分支)拉取最新更新
# 切换到 main 分支
git checkout main
# 拉取远程主分支的最新内容
git pull origin main
绝对禁止直接在 main 分支上修改。
git checkout main -> 改代码 -> git push (这是犯罪)
2. 创建并切换到新的分支(本地)
# 创建并切换到新的分支(zhangsan/note)
git checkout -b zhangsan/note
3. 写代码(本地)
新建 Markdown 文件,并同步修改修改 SUMMARY.md 。
4. 提交和推送(本地)
告诉大家你改了什么。
git add .
git commit -m "add new note about FPGA IO BANK"
# 推到云端
git push origin zhangsan/note。
5. 发起 PR(GitHub)
推完代码后,需要去 GitHub 网页上,点击绿色的 "Compare & pull request" 按钮。 写好标题(例如:“新增了显卡配置指南”)。