新项目提交人指南

以下是如何设置技术和社会环境,以支持您作为Apache项目提交者的工作。一些项目有项目网站或PMC为您提供的更具体的指南。我们还有一个彻底的提交人常见问题对于新的和有经验的提交者。

什么是提交人?

“committer”一词的简单含义是,您拥有对项目存储库的访问权限,因此可以阅读和编写源代码。现在,您可以创建本地补丁并自己提交,甚至可以查看和提交他人创建的补丁,而不是创建补丁并提交以供积极审查和提交。通常在您提交补丁后,您的同事会审查您的补丁。

成为一名委员

如果您还不是提交人,但希望成为提交人,请查看:

委员会的方式

作为提交者,您可以访问特定Apache项目的存储库,这样您就可以创建和编辑源代码文件,而不仅仅是读取它们。您现在可以创建一个本地补丁并自己提交,而无需创建和提交其他提交者必须审查和批准的补丁;您还可以查看和提交其他项目贡献者和提交者创建的补丁。您的补丁仍然可以由其他提交者审查。

一些项目使用RTC公司(审查然后提交)而不是CTR公司(提交,然后审查)。检查项目使用的模式,然后遵循它。

在编写代码时要比以前更加小心,因为现在可以直接更改内容,而无需审查。确保您了解项目的提交者是如何工作并相互协调的。如果有不确定的地方,请咨询您的项目PMC或项目的任何积极提交者,以获得指导。总的来说,你在项目中的能见度和参与度越高,你就越有乐趣,也就越有机会获得建议和反馈。

提交个人贡献者许可协议(ICLA)

如果您是一名全新的提交人,您必须填写并提交一份个人贡献者许可协议(ICLA),ASF才能激活您的提交人帐户。请注意,只有在PMC(或孵化器podling)邀请您的情况下才能创建帐户。ICLA是一份正式合同,其中声明了您将向ASF贡献知识产权的条款。请注意,ICLA确实将版权转让给ASF;您保留自己作品的版权。但是,它确实授予ASF足够的权利来发布您根据Apache许可提交的任何作品。

  • 在提交ICLA之前选择Apache ID。还要选择一个替代方案,以防您想要的ID不合适或已被占用。您的ID必须至少由三个小写字母数字字符组成,以字母开头。(此列表显示已获取的ID。)
  • 确定您的项目(PMC或孵化器吊舱)。
  • 重要信息:您可能需要在签署ICLA之前与您的雇主进行讨论,因为您的雇主可能有权对您所做的编码工作,甚至在您的工作之外。你的雇主甚至可能需要提供公司CLA-决定这是你的责任。确保及时了解此要求。
  • 阅读并理解ICLA规定的协议,并努力达到预期标准。正确的代码源标题对ASF非常重要,您也必须如此。
  • 确保您贡献的任何代码都是原创的,并且您公开贡献给ASF。如果有任何疑问(或者当一个贡献有复杂的历史记录时),请在提交之前咨询您的项目PMC。

有些程序可能看起来有点官僚主义,但它们是为了保护你和ASF。为了更清楚地理解,请阅读ASF许可证指南.

有关如何提交ICLA的详细信息,请参阅提交许可协议.确保你清楚填写ICLA。为了尽量减少打印错误的可能性,请将ICLA作为附件提交到您从ICLA中提供的电子邮件地址发送的电子邮件中。

接受您的ICLA

ASF秘书记录您的ICLA后,您的PMC可以提交您请求的ID以激活。验收过程可能需要一些时间。流程完成后,ASF将通知您和您的PMC主席。这个安静的间歇期是您熟悉Apache软件基金会的好时机。浏览开发人员指南和信息,关于ASF的材料基础设施、和基金会网站。我们定期更新网站。

您还需要熟悉一些Apache策略和过程。您可能已经通过潜移默化掌握了很多这方面的知识,您的项目的同事和PMC成员开发@邮件列表是第一个提问的地方。

关键委员会资源:

Apache Committer帐户创建

创建帐户后,您将收到一封电子邮件。(这可能需要一两周的时间。)现在是时候做一些常规任务了,可能还需要采取一些PMC将与您共享的特定于您的项目的其他步骤。

设置您的`@apache.org`电子邮件地址

阅读指导连接到Apache电子邮件收件箱并使用它。

记录您在中使用的任何电子邮件别名asf-altEmail(asf-alt电子邮件)LDAP记录中的字段。您可以通过自助应用程序。系统使用LDAP中的地址邮件转发发送给您的电子邮件的字段@apache.org网站地址。此字段必须至少有一个条目,该条目不能是您的@apache.org网站地址。

这个asf-altEmail(asf-alt电子邮件)字段用于验证订阅请求并关联订阅。(无需复制邮件中的条目asf-altEmail(asf-alt电子邮件).)

注释:请阅读处理ASF电子邮件帐户中的垃圾邮件不要将有效的ASF相关电子邮件标记为垃圾邮件。

设置Subversion或Git访问

阅读Apache的源代码管理存储库.

配置对项目Git存储库的访问

如果您的项目使用Git来存储、开发和部署其产品代码,那么您可以使用GitHub或Apache的Gitbox执行诸如合并pull请求之类的操作。

使用GitHub

要使用GitHub,您需要将GitHubID与Apache帐户集成,以便合并请求并执行其他Git任务。

  1. 验证是否使用启用了GitHub ID双因素身份验证(2FA).
  2. 使用合并Apache和GitHub帐户拳击手,GitHub的Apache帐户链接实用程序。遵循链接过程中概述的步骤。当您的帐户已经完全链接时,您应该会在Boxer中看到三张绿色支票。
  3. 大约两到五分钟后,您应该可以访问GitHub上的项目存储库。

使用Gitbox

要通过Gitbox连接到Git存储库,请访问Gitbox(Gitbox)并按照屏幕上的说明进行操作。

第一次提交到Git存储库

如果您的项目在其网站上有一个供开发人员和提交人使用的页面,请在其中添加您的姓名和信息。这是进行首次提交的好方法,有助于您的团队了解您。

它还有另一个用途:您将学习如何向项目的网站添加文档以及用于构建该网站的技术。文档是至关重要的,能够改进项目的网站是您需要的技能。如果您的项目没有记录如何重建网站,请在开发@邮件列表并使用答案创建一个描述如何执行此操作的文档。我们将不胜感激!

每个团队都有很多“部落知识”,团队成员在头脑中或私下笔记中都有这些知识,但整个团队都需要了解这些知识,才能正常运作,在灾难中幸存下来,就像关键团队成员突然变得不可用一样。您可以通过指出在哪里需要向团队成员寻求文档中找不到的指导来帮助将部落知识迁移到文档中。

设置安全密钥和PGP密钥

安全是至关重要的,Apache非常重视它。请记住,在任何时候,都要确保您的所有Apache密码都足够安全,并且您签入的任何代码都是安全的。

开放式PGP是一个标准它提供了(除其他外)为从电子邮件到ASF发布的文档创建数字签名的方法。许多应用程序都提供与OpenPGP兼容的签名,包括众所周知的GPG公司。我们建议您为您的apache.org网站地址(或将该地址添加到现有密钥中)。请勿在许多用户可以访问的任何机器上创建此密钥,并请勿永远不要将私钥复制到任何其他共享机器上。发布经理需要特别注意保管用于签署放行单的钥匙.

将公钥上载到公钥服务器,例如MIT PGP公钥服务器。然后将钥匙的主指纹添加到您的LDAP配置文件。系统会将您的密钥添加到个人和项目预取的KEYS文件,并让自动化工具加密与您的通信。

在你需要认真使用之前,现在就开始建立一个良好的信任网。准备在ASF人员可能出席的面对面活动中交换关键信息。最佳做法是在签署他人的密钥之前坚持进行身份验证。请参阅Apache发行版签名指南.

提交者资源

这个基础设施文档页面为提交者和其他Apache人员提供了资源列表。

签出仅提交者Subversion模块

办理私人结账提交人模块。这存储在subversion存储库中https://svn.apache.org/repos/private/committers。请参阅颠覆基础知识如果您不熟悉Subversion。

签出此模块后,请阅读文档目录,尤其是资源.txt文件。你需要了解许多私人邮件列表。加入Apache社区,注册您感兴趣的每个列表。最好注册(即使您稍后注销),也不要错过!请遵守这些私人列表的使用指南。

了解Apache社区

加入社区让Apache变得有趣。这个社区发展项目有一个跨越PMC边界的主题中央邮件列表。只要事情不是敏感或机密的,所有类型的讨论都是主题。

加入电子邮件列表

许多Apache知识共享和所有正式决策都在电子邮件列表中进行。大多数名单都是公开的,你可以加入并参与任何吸引你的名单。

  • 您的项目可能有开发@和a用户@电子邮件列表,最好同时加入这两个列表。
  • 我们强烈敦促所有委员会加入生成@电子邮件列表,来自许多项目的人员和基础架构团队在这里分享见解并解决与构建和发布软件包相关的问题。使用Jenkins或对CI/CD(持续集成和持续开发)感兴趣的人会发现这个列表非常宝贵。Infra还向此列表发布有关停机、升级、应用程序添加/删除等的通知。

加入和退出列表的说明以及Apache邮件列表的可浏览列表如下在这里.

承诺人责任

加入您的项目提交@开发@邮件列表以跟上项目活动。回答有关的问题用户@也非常感谢您的PMC。

每个提交人都有责任监控针对潜在问题所做的更改,包括编码和法律问题。如果您在提交中发现任何潜在问题,正确的做法是(对电子邮件)发布回复,向开发@列表。在极端情况下,可能有必要否决(-1)一项承诺,但这是一种极端的制裁,很少有正当理由。阅读投票指南在行使否决权之前。

如果您的第一次提交有延迟的差异电子邮件,请不要感到惊讶。它需要通过人类主持人。

参加ApacheCon

如果你还没有,在日记中记下下一个ApacheCon公司这是一个很好的机会,可以结识其他Apache人员,破解代码,了解伟大的新开源项目。随着会议日期的临近,请观看名单,了解提交人的特别交易细节和发言机会。

个人网络空间

一些Apache提交者的个人内容由ASF web服务器提供。关于适当的内容没有固定的准则:提交人应该知道如何行事!通常,人们使用此选项来托管与ASF相关的内容或展示有趣的私人项目。如果您确实使用此功能,请负责任地使用。

放置在公共html目录位于http://home.apache.org/~用户名/url(其中用户名是您的ASF帐户ID)。

身份盗窃

请注意,Apache Software Foundation提交人是身份盗窃的目标。这些欺骗攻击类似于网络钓鱼用于访问银行帐户和其他网络订阅的攻击。他们通常会试图说服你在一个虚假网站上输入你的访问详细信息。ASF将从未征求此类“验证”。

泄露您对Apache的访问权限可能会产生非常破坏性的后果。从未向任何人透露您的ASF密码。

Apache Infrastructure团队对DNS维护很敏感:do通过IP地址信任任何重定向。您可以通过服务于svn.apache.org网站域。机器的SSH/SSL指纹列在机器页面,以及我们的SVN服务器指纹也列出了。

请谨慎使用。如果您有疑问,请毫不犹豫地询问:在采取任何行动之前向基础设施部门提出问题。

分享你的智慧

请帮助改进此文档(请参阅指导方针用于更新这个网站).

志愿者如果你想帮助基础设施团队保持好船ASF漂浮。

最后一句话

欢迎!!

版权所有2024,Apache软件基金会,根据Apache许可证,2.0版.
Apache®和Apache羽毛徽标是Apache软件基金会的商标。