Skip to content

Latest commit

 

History

History
166 lines (121 loc) · 7.45 KB

CONTRIBUTING.md

File metadata and controls

166 lines (121 loc) · 7.45 KB
Raw

贡献者指南

感谢你为本项目付出宝贵时间！

下面会介绍本项目如何组织，想更改时应该怎样操作。

Note

下面大多只是指导性建议；如果你知道自己想做什么，跟着感觉走即可。

新增项目

若要添加新项目，有如下两种方法。

提交议题、拉取请求前有如下常见问题。

  • 请确保这一项目尚未被收录，而且还没有其他人请求。

    已收录的项目在 projects.yaml、README.md 两个文件，其他人的请求在议题，都可以搜索。

  • 不要直接改README.md，而是改projects.yaml。

    README.md内容是每周 GitHub Actions 自动生成的，不用直接编辑。

  • projects.yaml采用 YAML 格式，内容见项目属性一节。

    下面是个例子，可照猫画虎。

    - name: BIT101
  homepage: https://bit101.cn
  github_id: flwfdd/BIT101
  category: website
  labels: [Web, python]

  • 如果要添加好几个独立的项目，请分成多个议题／拉取请求。

  • 议题、拉取请求的标题请以“新增项目：”开头。

    直接使用模板即可。

  • 如果项目哪类也不算，category（类别）请写“杂项”（misc）。

    另外可以新建议题添加类别。

更改项目

若要更改现有项目，有如下两种方法。（和新增项目一样）

提交议题、拉取请求前有如下常见问题。

  • 不要直接改README.md，而是改projects.yaml。

  • projects.yaml采用 YAML 格式，内容见项目属性一节。

  • 如果要添加好几个独立的项目，请分成多个议题／拉取请求。

  • 议题、拉取请求的标题请以“更改项目：”开头。

项目属性

Note

最新完整列表请参考 best-of-generator 文档或我们克隆的版本。

属性 描述
name 项目名称。必须和其它项目不同。
github_id GitHub ID，由作者名（或组织名）、仓库名组成，例如best-of-lists/best-of-generator。
gitee_id Gitee ID，格式同github_id
greasy_fork_id Greasy Fork ID，是 URL 中的数字，例如https://greasyfork.org/scripts/299792458-speed-of-light中的299792458。
可选属性：
category 类别的 ID。若项目涉及好几类，请只写最相关的那一类。具体 ID 请参考projects.yaml里的categories。若不填，则会归入“Others”。
labels 项目相关的标签的列表。具体 ID 请参考projects.yaml里的labels。
支持的包管理器：
pypi_id Python Package Index（PyPI）上的项目 ID。
conda_id Conda package manager 上的项目 ID。如果主包在别的 channel，要前缀 channel，比如 conda-forge/tensorflow。
npm_id Node package manager（npm）上的项目 ID。
dockerhub_id Docker Hub container registry 上的项目 ID。
maven_id Maven central 上的 artifact ID，例如org.apache.flink:flink-core。

方针

收录标准

一言以蔽之：都收！

可行性：归功于 best-of 的自动排序，高质量项目会排到前面，长期不活跃的项目会被折叠隐藏。

意义：排除偏见，广而告之，考古指南，互帮互助，……

如何收录 monorepo 型项目

  • name请用➡️分隔，例如Batch_Collections ➡️ Campus_network。
  • 必须提供description。默认爬取的描述是整个仓库的描述，提供description可以人为指定，覆盖这一行为。（例外：如果提供了greasy_fork_id，会优先使用 Greasy Fork 的描述，从而可不提供description。）
  • github_id仍写整个仓库的。

上游项目

除了项目，本列表还涉及收集元数据、生成 markdown 等。这方面的贡献请移步 best-of-generator 仓库或我们克隆的版本。

若您想自己创建一个 best-of list，请参考官方教程，大概需要三分钟。完成后 GitHub Actions 可以自动运行 best-of-generator。

贡献者公约

参与此项目即代表遵守贡献者公约。相互尊重才有我们才能合作干实事。辱骂、骚扰或其他不可接受的行为可向社区监督人报告。