贡献指南

相关源文件

• .github/workflows/links-checker.yml
• .github/workflows/stale.yml
• CONTRIBUTING.md

目的与范围

本文档概述了贡献Front-End Checklist项目的官方指南。它详细介绍了有助于保持项目质量的各种贡献类型、工作流程和流程。有关提交拉取请求的具体信息，请参阅拉取请求流程，有关报告问题的请参阅问题报告。

贡献类型

Front-End Checklist欢迎除了代码之外的各种形式的贡献

贡献类型	描述	示例
代码	直接改进存储库内容	错误修复、功能实现、文档更新
QA	质量保证协助	详细的错误报告，包含截图、控制台日志
市场营销	项目推广	博客文章、教程、社交媒体推广
社区	壮大用户社区	在聚会中发表演讲、组织活动
财务	资金支持	Open Collective捐款、GitHub赞助

来源： CONTRIBUTING.md7-12

贡献工作流程

下图说明了Front-End Checklist项目的标准贡献流程

来源： CONTRIBUTING.md18-25

开始第一次贡献

对于首次贡献者，项目推荐免费教育系列“如何在GitHub上为开源项目做贡献”（在CONTRIBUTING.md16中引用）。该资源提供了有关首次贡献的详细分步指南。

代码提交指南

向存储库提交代码更改时

1. 将所有代码更改作为拉取请求提交
2. 包含清晰的描述，解释代码的作用
3. 提供执行和测试代码的步骤
4. 随更改提供适当的测试
5. 将大型拉取请求分解成更小、可管理的块
6. 提供更改为何重要的背景信息

来源： CONTRIBUTING.md18-25

自动化维护流程

Front-End Checklist 使用多个自动化流程，贡献者应了解这些流程

过时问题和拉取请求管理

过时管理流程强制执行以下规则

• 不活跃40天的问题会被标记为过时
• 不活跃45天的拉取请求会被标记为过时
• 标记为过时的项目在持续不活跃10天后将被关闭
• 活动（评论、更新）会移除过时状态
• 某些标签可以豁免项目不受过时流程影响

来源： .github/workflows/stale.yml1-37

链接验证

此自动化流程可确保所有文档链接保持有效，从而维护项目资源的质量。检查器每周运行一次，并为在README.md文件中找到的任何损坏链接创建问题。

来源： .github/workflows/links-checker.yml1-36

财务贡献

项目欢迎通过Open Collective提供财务支持

1. 贡献者可以通过Open Collective平台成为支持者或赞助者
2. 任何人都可以提交与项目相关的活动的费用报销申请
3. 核心贡献者审查费用，以确保其有利于社区
4. 批准的费用将通过Open Collective报销

财务贡献有助于项目的可持续性，并以完全透明的方式进行管理。

来源： CONTRIBUTING.md27-30

社区支持和提问

当您对项目有疑问时

1. 首先搜索现有问题，看是否已经得到解答
2. 如果没有，创建一个新问题来提出您的问题
3. 您还可以通过项目的Open Collective邮箱联系团队

项目维护者力求及时回复问题。

来源： CONTRIBUTING.md32-35

贡献者鸣谢

Front-End Checklist项目的所有贡献者都将获得公开认可

• 代码贡献者列在GitHub贡献者页面和Open Collective中
• 财务支持者将在README和Open Collective中得到认可
• 赞助商将根据其贡献级别获得特别认可

此认可系统有助于围绕项目建立社区，并承认所有形式的支持。

来源： CONTRIBUTING.md39-54

贡献系统集成

贡献指南是Front-End Checklist生态系统的一个核心组成部分，与其他项目系统相连接

这些系统协同工作，以促进贡献管理并维护项目质量。贡献者在与项目互动过程中会与多个系统进行交互。

来源： CONTRIBUTING.md1-57 .github/workflows/stale.yml1-37 .github/workflows/links-checker.yml1-36