跳至内容

维护者指南

欢迎使用 PROJECTNAME 维护者指南!

我们鼓励您根据外部贡献者对项目的贡献,将他们提升为维护者。但是,如果策略不允许外部维护者,请移除不相关的部分。无论如何,通信和发布相关部分都应保留。

如果您的项目不打算使用文档站点(如果项目非常简单,使用文档站点会显得过度),则以下信息应出现在项目的 MAINTAINING.md 文件中,并从README 模板中进行引用。

在以下部分中,如果内容像几行一样简单,请将其放在此处,否则创建单独的文件并从这些部分中引用它们。如有需要,添加其他部分。

维护者职责

项目维护者以合理的时间内对拉取请求或问题提供反馈、回复或操作。他们还可以与 PROJECTNAME 社区以及项目的其他维护者合作,更新项目的贡献者和维护者指南。

一般来说,项目维护者

  • 按照社区行为准则行事。
  • 跟踪存储库中的活动(在 GitHub 中点击Watch > All activity)。
  • 保持 README、开发指南和其他通用项目文档的相关性。
  • 审查和提交其他贡献者所做的更改。
  • 将更改回移植到受支持的分支。
  • 处理问题或将其分配给合适的贡献者。
  • 发布项目。
  • 在社区和项目间通信中代表项目。
  • 建立一个健康的社区,以增加围绕集合的活跃贡献者和维护者的数量。

多个维护者可以相互之间分配职责。

如何成为维护者

PROJECTNAME 维护者是社区信任的贡献者,他们对项目做出重大且定期的贡献,并且已证明自己是相关领域的专家。维护者在项目存储库中拥有扩展的权限。

有兴趣成为维护者并满足要求的人员可以自行提名或由其他维护者提名。要提名候选人,请在相关集合存储库中创建一个 GitHub 问题。

治理

使用相关信息和 URL 更新此部分。

本项目的决策过程基于参与者之间的讨论和达成共识。

我们,在此处引用您的论坛组,使用带有TAGNAME标签的论坛帖子进行一般公告和讨论。如果您有任何想法,只需创建一个帖子,让我们一起找到最佳解决方案!

发布

从项目 README 中引用此部分。

版本控制约定

描述项目遵循的版本控制策略(例如SemVer)。

为了在发布时确定软件版本号,本项目使用语义版本控制规范来传达从一个版本到下一个版本所修改内容的含义。

发布策略和维护时间线

在本节中描述您的发布策略和维护时间线,或参考相应的文档站点页面。描述如何进行弃用。如果相关,请提供变更日志和路线图的链接。

我们在发布下一个主要版本后的两年内维护每个主要版本(1.x.y、2.x.y 等)。

以下是支持时间线的表格

  • 1.x.y:发布于 2020-11-17,已结束生命周期
  • 2.x.y:发布于 2022-02-10,支持至 2025-06-09
  • 3.x.y:发布于 2023-06-09,当前版本

执行发布

描述如何计划、执行和宣布发布。为了方便上手,请创建一个单独的分步发布指南(请参阅集合的示例)。

辞去维护者职务

如果您觉得您没有时间再维护该项目,我们要求您不要默默地退出。请在项目存储库中打开一个问题来宣布此决定。

如果您是唯一的维护者,请尝试从活跃的贡献者中找到新的维护者,并在他们同意承担项目的责任时提升他们。

如果您未能找到替代者,请在存储库中创建一个置顶问题,宣布该项目需要新的维护者。还在相应类别/标签下的论坛以及Bullhorn 时事通讯中发布公告。