XHGit · 产品文档

初次使用与功能全览

认识 XHGit、注册登录、寻找项目,完成第一次协作。

01

阅读导览

XHGit 把代码仓库、议题、合并请求、自动构建和社区讨论放在同一站点。可以先浏览公开内容,再按站点当前的注册策略建立账号。本页用一个测试仓库串起常用操作;功能入口会随站点设置、仓库设置和你的权限变化。

02

找到你需要的内容

  1. 打开探索仓库,输入项目名称或关键字。搜索结果会随输入更新,排序和筛选仍可继续使用。
  2. 点击顶栏搜索按钮,在弹出的搜索界面查找内容;需要更细筛选时进入对应的探索或仓库页面。
  3. 打开仓库后先读 README、描述、许可证和最近的提交,再决定下载、关注或参与讨论。

公开可见不等于允许修改。私有仓库需要拥有者或组织授予权限;知道地址也不会自动获得访问权。

03

注册并完成验证

  1. 进入注册页面,按页面提供的手机或邮箱方式填写账号信息。
  2. 如果要求验证码,先完成短信或邮件验证。管理员可以配置必须手机验证、必须邮箱验证,或允许二者任选其一。
  3. 如果显示用户协议,阅读后勾选同意,再提交注册。
  4. 登录后进入账号设置,确认联系方式已验证。详见账号与安全。

注册入口关闭时,需要联系站点管理员;换一个入口不能绕过注册策略。

04

认识登录后的工作台

顶栏提供议题、合并请求、探索等入口;头像菜单连接个人设置与退出登录。工作台会按权限展示你参与的仓库和活动。部分界面把 Issue 显示为“工单”,它与本帮助中的“议题”是同一种协作对象。

  1. 在头像菜单进入个人设置,填写显示名称和简介。
  2. 上传头像;没有个人头像时会使用站点配置的默认头像。
  3. 为常用项目点“关注”,通过通知了解后续变化。关注、点赞和派生的作用不同,不会相互替代。
05

创建一个练习仓库

  1. 打开创建仓库,选择自己的账号作为拥有者。
  2. 用 hello-xhgit 这类清晰名称,填写描述,按需要设为私有。
  3. 勾选初始化 README,选择适合项目的忽略文件和许可证,然后创建。
  4. 在仓库“代码”按钮中复制克隆地址。浏览器编辑适合少量文字修改,日常开发建议使用本地 Git。

名称必须通过页面校验;中文项目标题可以写在描述或 README,不要依赖自动替换后形成的横线名称。更多设置见仓库管理。

06

完成一次可审查的修改

  1. 克隆仓库,在本地创建功能分支,修改 README 并提交。
  2. 推送这个分支,进入仓库“合并请求”,选择目标分支和你的功能分支。
  3. 写清修改目的与验证方式,提交后在差异页面检查文件内容。
  4. 等有权限的维护者审查并合并。代码操作见Git 入门,审查流程见合并请求。

把问题描述写到议题,把准备合入的代码写到合并请求,会让后续沟通更清楚。

07

选择合适的下一步

需要排期可用项目看板,需要说明书和下载版本可用Wiki 与发布,依赖包托管见软件包,多人权限分工见组织与团队。

站点级交流进入论坛,查看论坛使用指南。自动打包入口在仓库 Actions 中;它依赖可用 Runner 和项目自身的构建命令,提交代码并不意味着所有项目都会自动产生安装包。

08

遇到入口缺失或操作失败

先确认登录的是预期账号,再检查仓库是否私有、已归档、镜像或尚未初始化。记录出现问题的页面地址、发生时间、错误提示和你预期的结果,提交给维护者。截图应遮住令牌、验证码、手机号和邮箱等信息。常见问题按故障排查逐项定位。