跳转至

贡献守则

我们欢迎更多的同学对该repo有更多建议和优化方案，欢迎您使用Forking工作流提交 Pull Request，具体参考atlassian文档，大致步骤如下：

  1. 在GitHub上Fork本仓库
  2. Clone Fork后的个人仓库
  3. 设置upstream仓库地址，并禁用push
  4. 我们建议使用分支开发
  5. PR之前保持与原始仓库的同步，之后发起PR请求
  6. PR通过后，我们会将您的PR合并到主分支中

命令示例 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# fork
# clone forked repo
git clone git@github.com:USERNAME/XDU-WiKi.git

# set upstream
git remote add upstream git@github.com:InsightsXDU/XDU-WiKi.git
# disable upstream push
git remote set-url --push upstream DISABLE
# verify
git remote -v
# origin  git@github.com:NoFish-528/XDU-WiKi.git (fetch)
# origin  git@github.com:NoFish-528/XDU-WiKi.git (push)
# upstream        git@github.com:InsightsXDU/XDU-WiKi.git (fetch)
# upstream        DISABLE (push)

# 新建分支<可选>，并切换到该分支
git checkout -b <branch_name>
# edit and commit and push your changes
git push -u origin <branch_name>

# 以下内容均可选，但建议执行
# keep your fork up to date
## fetch upstream main and merge with forked main branch
git fetch upstream
git checkout main
git merge upstream/main
## rebase brach and force push
git checkout <branch_name>
git rebase main
git push -f

贡献内容示范

本项目基于mkdocs构建完成，当您fork到本地后，如果想要贡献内容，请在XDU-WiKi/doc/对应模块 内容下修改或增加您想贡献的内容，之后在XDU-WiKi/mkdocs.yml配置文件中修改对应的目录，当PR并入后效果就将呈现在在线网站上。

示例如下：

当我想要在开始界面中增加自我介绍文件：

  1. fork仓库至我的仓库中
  2. 克隆该仓库
  3. 在本地打开该仓库
  4. 增加docs/开始/自我介绍.md

  5. 修改对应的mkdocs.yml文件中内容，同时在docs/参与贡献/项目结构.md中修改对应内容
    原文件 

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
    nav:
  - 开始:
      - 欢迎: index.md
      - 快速了解Agent: 开始/start.md
  - Agent_论文推荐: Agent_论文推荐/start.md
  - Agent_项目分享: Agent_项目分享/start.md
  - Agent_论文解读: Agent_论文解读/start.md
  - 参与贡献:
      - 如何贡献: 参与贡献/如何贡献.md
      - 项目结构: 参与贡献/项目结构.md
  - 关于 Datawhale: https://datawhale.club/
    修改后 
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    nav:
  - 开始:
      - 自我介绍: your_markdown.md
      - 欢迎: index.md
      - 快速了解Agent: 开始/start.md
  - Agent_论文推荐: Agent_论文推荐/start.md
  - Agent_项目分享: Agent_项目分享/start.md
  - Agent_论文解读: Agent_论文解读/start.md
  - 参与贡献:
      - 如何贡献: 参与贡献/如何贡献.md
      - 项目结构: 参与贡献/项目结构.md
  - 关于 Datawhale: https://datawhale.club/

  6. 提出PR等待并入

  7. PR合并后查看在线网页更新内容

贡献内容中，请您在您贡献的标题页下加入您的姓名
形式如下：
标题
author:xxx
感谢您的贡献！

Contributors

Made with contrib.rocks.