Apache 项目管理委员会 (PMC) **必须** 每季度向董事会报告其项目的健康状况和状态。虽然 PMC 独立管理自己的技术事务,但董事会提供监督,以确保项目继续作为健康、社区驱动和共识驱动的项目运营,以支持我们的使命。另请参阅PMC 职责常见问题解答。PMC 主席和 Apache 成员始终欢迎参加每月董事会会议。
目录
**每个 PMC 的主席** 负责每季度提交其项目的报告,至少在每个董事会会议前**一周**提交,具体时间表请参见
https://svn.apache.org/repos/private/committers/board/committee-info.txt
延迟报告或在上述时间表之外报告不会改变此时间表:例如,如果您应该在 1 月份提交报告,但错过了并且在 2 月份提交了报告,那么您的下一份报告仍然在 4 月份到期。如果您未在董事会充分审查报告所需的时间内提交报告,则会要求您在下个月重新提交报告。
虽然在大多数情况下,主席会与其他 PMC 成员合作编写报告,但最终由主席负责完成并提交报告。董事会向主席和 PMC private@ 邮件列表发送多条自动提醒,以帮助您记住此任务。
例外情况:新毕业的 PMC 必须在离开 Apache Incubator 后头三个月内提交每月报告。Apache Incubator 中的所有 Podling 都使用孵化器 Podling 状态流程填写类似的报告。
您必须将报告内容提交到董事会的每月会议议程。
使用 Whimsy 议程工具或 ComDev 项目报告工具,该工具会为您生成一个方便的框架
https://whimsy.apache.org/board/agenda/
https://reporter.apache.org/
发布报告
按钮命令行用户可以自由地检入他们的报告,遵循现有格式,以便自动化工具可以解析它们,此处
https://svn.apache.org/repos/private/foundation/board/
如果 PMC 有值得注意的事情要报告或需要反馈,董事会欢迎 PMC 在其计划的报告之外提交任何报告。在这种情况下,主席可以将报告作为附件添加到议程末尾,并为其创建相应的评论部分。
虽然报告的主要受众是董事会,但请记住,报告在会议结束后会公开,并提供项目的编年史。最好以您希望社区现在了解的信息编写报告,并以一种对将来查看报告的人员提供有用历史的方式编写。
您可能也希望通过用户列表或项目网站与您的项目社区共享报告的公开部分。
Apache 委员会报告工具可以简化收集报告数据的过程,但您必须编辑并添加从生成的模板中获取的信息,以涵盖以下要点。
提交报告时,请勿在报告中保留任何TODO 标记。
这些要点**不是**模板;项目不应简单地将这些要点复制粘贴到其报告中。相反,这些是董事会希望了解的主题,以便能够评估项目的健康状况和状态。并非所有主题都与每个报告相关;但是主席在撰写报告时应考虑每个问题。
简要描述您的主要软件产品的功能。**[必填]**
例如
The Apache Xerces XML parsing library is easily configurable
and compliant with current standards.
请注意,此描述应类似于主要网站使用的软件产品的基本商标描述。
请参阅品牌命名和描述。
使用以下关键字之一指示您的**项目状态** **[必填]**
当然,这是主观的,但有助于根据项目的生命周期阶段调整董事会的期望。如有需要,欢迎添加评论。
用几句话总结项目和社区的状态和健康状况
以一段描述您项目在过去一个季度主要工作内容的段落开头,将有助于读者理解您想要传达的关键要点,并且对那些想要总结报告或快速收集基金会中正在发生的事情的信息的人员很有帮助。然后,您可以使用以下内容作为指导,在报告的其余部分扩展这些要点。
董事会既关注项目正在进行的技术更改,也关注社区的健康状况:是否解答了用户问题,贡献者是否行为得体,是否有新贡献者出现?
董事会是否有任何需要处理的问题?
如果有董事会应该了解或应专门解决的具体问题,请指出来。如果没有,则说明“目前没有董事会层面的问题”也很有帮助。
如有疑问,最好在报告中包含 PMC 拥有的信息或问题,而不是等待。另请记住,您可以随时通过电子邮件,在私下存档的[email protected]列表中向董事会提问。
项目上次发布版本是什么时候?**[必填]**
定期发布软件产品是项目健康的标志。报告应列出过去一个季度发布的版本,**并附带发布日期**。
**注意**: 如果没有发布任何版本,请列出之前发布的最新版本的日期,以便董事会确定自项目上次发布版本以来已经过去了多长时间。
描述过去一个季度项目中的总体活动。
通过简要讨论用户和开发者列表的活跃程度来帮助董事会评估项目的活动和健康状况。是否回答了用户问题?是新开发还是仅仅修复错误?开发社区是否定期阅读和回复用户邮件和问题?
**注意**: 如果活动最少,请验证是否有至少三名活跃的 PMC 成员可以在需要时介入,并在报告中包含此信息。
描述项目的当前计划
一个健康的项目通常会朝着一个共同的目标努力,或者对接下来要做什么有一个共同的理解——即使个人贡献者有自己的“痒点”。正在开发的主要功能是什么?计划发布哪些版本?是否有任何特定的工作或开发分支正在进行?提供摘要,无需深入探讨技术细节。
除了报告之外,如果项目计划发布重大公告,请与营销和宣传委员会联系[email protected]
,以协调公告和新闻稿。
相反,如果活动很少,请讨论项目计划如何解决这个问题——无论是通过寻找新的贡献者,保持休眠但可用的状态,还是准备迁移到Apache Attic。如果您需要帮助吸引新的贡献者,可以向Apache 社区发展寻求建议。
最新的提交者或 PMC 成员是什么时候选出的?[必填]
健康的项目倾向于定期增加新的提交者和 PMC 成员。
报告应指明最近添加提交者的日期和最近添加 PMC 成员的日期到您的项目中,无论这些日期是否在当前报告期内。
PMC 和提交者多样性
一个健康的项目应该能够经受住任何单个贡献者或贡献者雇主离开的影响。健康的项目也满足许多方的需求。因此,ASF 倾向于项目拥有多元化的 PMC 和提交者。如果PMC 对其多样性有任何担忧或认为存在问题,则报告应包含有关其 PMC 和提交者中目前有多少个唯一组织的信息。
项目品牌或命名问题,无论是在项目内部还是外部。
项目的品牌——或名称和徽标——是识别 Apache 项目的重要方式,也是新用户成为贡献者的关键途径。项目是否一致地使用其品牌?是否有第三方不正当地或以损害您的项目的方式使用您的项目名称、徽标或良好声誉?
如果您的项目网站品牌不完整(请参阅清单),请包含有关您将如何与品牌委员会合作完成任何剩余项目的具体计划。
注意:将所有其他品牌问题提交给品牌委员会,而不是将其包含在董事会报告中。
法律问题或疑问
虽然法律事务委员会处理任何法律问题,但请务必在您的董事会报告中提及发生的任何问题。
基础设施问题或战略需求
虽然基础设施团队负责为我们的项目提供所需服务的细节,但请随时在您的董事会报告中包含任何担忧、战略建议或请求。
不要让与项目相关的商业活动主导报告。
每个 Apache 项目的PMC 管理项目——而不是任何第三方或外部组织。项目报告应关于项目本身,不应讨论外部组织的活动,除非这些活动与项目的健康状况直接相关。
未明确标记的情况下,不要在报告中包含私人事务(见下文)
不要使用非 Apache URL 缩短器。
如果您希望在报告中包含一个长 URL,**仅**使用https://s.apache.org/
URL 缩短器(需要 Apache 登录)来提供较短的链接。Apache 无法控制外部 URL 缩短器将存在多长时间,或将维护给定的缩短 URL。如果您提到邮件列表线程,**仅**使用https://lists.apache.org
URL 到该邮件列表线程,原因相同。
除非信息指向可能私下包含的多样性问题,否则无需在报告中包含有关提交者关联的详细信息。
偶尔,项目可能需要私下向董事会报告某些内容,但又不希望该信息在公开记录中发布。请记住,所有 Apache 董事会报告都会公开,通常在董事会会议后一两个月。
您的报告中欢迎此类信息,但请将其包含在
<private>
和
</private>
标记符内,**每行一个**,以便我们知道从公开记录中省略什么。要验证私有标记是否有效,请在 Whimsy 中发布您的报告,然后刷新页面。
正确标记的私有部分以灰色背景显示。
如果问题极其敏感,并且您非常关心隐私,则可以改为直接发送电子邮件至board-private@或某个董事会成员,他们会将信息转达给董事会。
项目报告是让董事会了解项目状态和健康状况的关键方式。鉴于 Apache 项目的多样性,这些指南无法涵盖所有情况。请随时在您的报告中包含您认为对您的项目很重要的任何其他信息。
特别是,如果 PMC 主席或其他成员在项目中看到任何“问题点”——即使是潜在的——请务必在您的董事会报告中包含一条关于它们的说明。最好在报告中包含您的担忧——或您 PMC 部分成员的担忧——而不是让董事会以后可能发现它们。
最后,如果您发现自己的项目似乎没有足够的活动来创建很多报告,那么请务必报告这一事实。一个健康的项目应该意识到它是否正走向 Apache Attic。迁移到 Attic 并不是失败;它只是认识到项目可能已经成熟、偏离轨道或被其他技术所取代,我们应该认识到这一事实。
董事会依靠项目主席的报告来了解项目的状况和健康状况。如果董事会无法强烈感受到您的项目进展如何,那么我们将在不久的将来联系您以获取后续报告。
项目报告不是单向的沟通方式。它们也是与董事会互动的一个机会。项目主席欢迎以嘉宾身份参加董事会会议并讨论他们的报告。他们还可以突出他们希望董事会考虑的具体问题(在报告中或通过要求将更广泛的讨论议题列入议程)。
当然,主席也可以随时利用这个机会在 Board@ 邮件列表中提出任何这些讨论,无论是在其报告期内还是报告期外。
每次您需要提交报告时,都会随机指定一位董事作为您项目报告的“牧羊人”。如果您的报告迟交,他们将负责跟进;如果存在重大意见或缺乏批准,他们将在会议期间描述该报告;并在会议后将任何后续消息或行动传达给您的 PMC。
在会议前,董事们在审查报告时,可能会在您的报告旁边的议程中添加评论。我们鼓励项目主席关注此董事会反馈(目前可以通过监视 SVN 提交或使用Whimsy议程工具),并在实际情况下在会议前回复。
董事会会议通常遵循以下模式
如您所见,确保我们及时收到您的报告,其中包含所有必要的详细信息,以及您解决任何评论,这极大地提高了董事会会议的流程,董事会每个月需要处理 80 多个项目和子项目的报告,以及其他事务。