Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 1.79 KB

贡献者指南

欢迎反馈、bug报告和拉取请求,可点击 issue 提交.

如果你是第一次进行 GitHub 协作,可参阅: 协同开发流程

📢 前提:注意所提交的项目只能是 github 中的项目,否则表格中的其他字段将无法正常展示。

  1. 此项目的 README 通过 action 自动生成,请勿编辑此文件。

  2. README 中的文件,取自于 items/*/*.yaml 文件,如果你要新增一个项目,请在对应分类下拷贝一个文件,然后按照其内容规范进行填写:

kind: OpenLDAP
owner: eryajf
repo: go-ldap-admin
desc: '🌉 基于 Golang+Vue 实现的 OpenLDAP 后台管理项目'
desc_en: '🌉 OpenLDAP background management project based on Golang+Vue'
  • 如上四个字段缺一不可,否则会导致内容渲染失败。
  • kind: 以此字段进行归类,通常与上一层的目录名一致。
  • owner: 仓库的用户名,或者组织名。📢 注意:如果你的这个字段全部为数字,请用双引号包裹。否则 action 将会执行失败。
  • repo: 仓库名。📢 注意:如果你的这个字段全部为数字,请用双引号包裹。否则 action 将会执行失败。
  • desc: 用简短的话介绍一下这个项目。请注意,此内容当中不要包含|之类的关键字,这会作为表格的一个列呈现。
  • desc_en: 用英文来简单描述概括一下这个项目。请注意,此内容当中不要包含|之类的关键字,这会作为表格的一个列呈现。
  1. 如果你不知道项目该如何分类,或者该项目目前没有对应分类,可以尝试先创建分类目录,然后再添加项目。