菜单

项目贡献

相关源文件

目的与范围

本文档提供了有关如何为Front-End Checklist项目做出贡献的全面指南。它涵盖了各种贡献类型、代码提交流程、问题管理、财务贡献和认可机制。有关项目技术实现细节的信息,请参阅技术实现

贡献类型

Front-End Checklist项目欢迎各种形式的贡献,而不仅仅是代码更改。了解这些贡献途径有助于新贡献者找到最适合参与的方式。

来源: CONTRIBUTING.md7-12

开始第一次贡献

对于开源新手,本项目提供资源帮助理解贡献流程。

学习资源

如果您正在进行第一次Pull Request,本项目推荐egghead.io上提供的免费教程系列“How to Contribute to an Open Source Project on GitHub”。

来源: CONTRIBUTING.md14-16

代码贡献流程

为Front-End Checklist贡献代码遵循结构化的工作流程,以确保代码质量和项目稳定性。

提交代码

提交代码更改时

  1. 所有更改都应以pull request的形式提交
  2. PR描述应解释代码的功能并提供执行步骤
  3. Pull request应包含测试
  4. 较小的PR比大型PR更容易审查和合并
  5. 为您的PR提供上下文有助于审阅者理解其目的

来源: CONTRIBUTING.md18-25 .github/workflows/stale.yml20-36

问题管理

问题是项目维护的重要组成部分。本项目采用手动和自动流程来有效管理问题。

问题报告最佳实践

报告问题时

  • 在创建新问题之前搜索现有问题
  • 包含详细信息(如适用,附带打开控制台的截图)
  • 遵循提供的任何问题模板

来源: CONTRIBUTING.md8 CONTRIBUTING.md33-35 .github/workflows/stale.yml20-36 .github/workflows/links-checker.yml1-36

财务贡献

本项目通过透明的流程欢迎财务贡献。

财务贡献通过Open Collective进行管理,其中

  • 任何人都可以成为支持者或赞助者
  • 所有财务交易都是透明的
  • 社区成员可以提交与项目相关的费用报销
  • 核心贡献者审查并批准合法的费用
  • 提交已批准费用的贡献者将获得报销

来源: CONTRIBUTING.md27-30 CONTRIBUTING.md45-54 .github/ISSUE_TEMPLATE.md1-2

获取帮助

如果您需要贡献方面的帮助

  1. 首先查看现有问题,看您的问题是否已被解决
  2. 如有需要,创建新问题并提出您的问题
  3. 请直接联系团队,邮箱为 hello@front-end-checklist.opencollective.com

来源: CONTRIBUTING.md33-35

认可系统

项目系统地认可了各种类型的贡献者。

认可类别

贡献者通过几种方式得到认可

  • 代码贡献者:列在GitHub贡献者图中,并在CONTRIBUTING.md中显示
  • 支持者:在CONTRIBUTING.md和README中感谢的个人财务支持者
  • 赞助者:提供财务支持的公司和组织,以其徽标显示

来源: CONTRIBUTING.md39-56

自动化维护流程

项目采用多项自动化流程来维护质量和响应速度。

陈旧问题管理

一个GitHub Action每周运行一次,用于识别和管理已过时的issue和pull request

实体类型闲置(Stale)后关闭(Close)后豁免
问题闲置40天闲置10天后关闭标记为“keep-unstale”或“security”的issue
Pull Requests闲置45天闲置10天后关闭标记为“keep-unstale”、“security”、“dependabot”、“wip”或“need-help”的PR

自动化在标记项目为“stale”和关闭项目时发送通知消息。

每周GitHub Action运行,检查存储库中的损坏链接

  1. 每周一执行,使用Lychee链接检查器
  2. 根据lychee.toml中的配置检查README.md中的链接
  3. 发现损坏链接时自动创建issue

来源: .github/workflows/stale.yml1-37 .github/workflows/links-checker.yml1-36

结论

为Front-End Checklist做贡献旨在让不同技能水平和兴趣的贡献者都能参与。无论是通过代码、测试、文档、社区支持还是财务赞助,所有贡献都有助于维护和改进这个宝贵的开发者资源。