完整贡献指南：如何为endoflife.date添加新的产品支持信息

完整贡献指南如何为endoflife.date添加新的产品支持信息【免费下载链接】endoflife.dateInformative site with EoL dates of everything项目地址: https://gitcode.com/gh_mirrors/en/endoflife.date你是否想为开源项目贡献自己的力量但不知道从何开始今天我将为你详细介绍如何为 endoflife.date 项目添加新的产品支持信息。endoflife.date 是一个追踪各种产品生命周期结束日期和支持周期的信息网站帮助开发者和管理员及时了解软件、操作系统和其他技术的支持状态。为什么贡献给 endoflife.dateendoflife.date是一个非常有价值的资源它汇集了各种产品的生命周期信息让用户可以轻松查找特定版本的结束支持日期。对于系统管理员、开发者和技术决策者来说这是一个不可或缺的工具可以帮助他们做出明智的技术升级决策。通过为 endoflife.date 添加新的产品信息你不仅可以帮助整个技术社区还能学习到开源项目的工作流程和协作方式。这个项目的贡献门槛相对较低即使你不是专业开发者也能轻松参与准备工作与环境搭建在开始之前你需要克隆项目仓库并设置本地开发环境。虽然对于简单的产品信息添加你不需要运行完整的本地环境但了解整个流程还是很有帮助的。克隆仓库git clone --recurse-submodules https://gitcode.com/gh_mirrors/en/endoflife.date.git cd endoflife.date安装依赖项目使用 Jekyll 构建需要 Ruby 和 Bundler。如果你只是想添加产品信息可以跳过这一步直接在 GitHub 网页界面上操作。# 安装 bundler gem install bundler # 安装项目依赖 bundle install # 运行本地服务器 bundle exec jekyll serve --host localhost --port 4000添加新产品信息的完整步骤1. 选择合适的模板endoflife.date 使用统一的 YAML 前端元数据和 Markdown 格式来组织产品信息。你可以参考现有的产品文件作为模板比如products/ubuntu.md - 操作系统示例products/python.md - 编程语言示例products/nodejs.md - 运行时环境示例2. 创建产品文件在products/目录下创建一个新的 Markdown 文件文件名应该使用小写字母和连字符格式为产品名称.md。例如如果你要添加 MyProduct文件名应该是myproduct.md。3. 填写 YAML 前端元数据每个产品文件都以 YAML 元数据块开始包含以下重要字段必需字段title: 产品名称category: 产品类别app、database、device、framework、lang、os、server-app、service、standardpermalink: 产品页面的永久链接releases: 版本发布信息列表可选但重要的字段releasePolicyLink: 官方发布政策链接versionCommand: 检查当前版本的命令iconSlug: Simple Icons 图标标识符auto: 自动更新配置identifiers: 产品标识符用于 SBOM 工具4. 填写产品描述在 YAML 元数据之后添加产品的 Markdown 描述。描述应该包括关于产品的一行简介并链接到官方网站发布政策的简短摘要突出 EoL 政策任何其他相关信息产品信息格式详解版本信息结构每个产品的releases字段包含一个版本列表每个版本都有以下字段- releaseCycle: 1.2 # 发布周期名称必需 releaseDate: 2023-01-01 # 发布日期必需 eol: 2025-01-01 # 生命周期结束日期必需 latest: 1.2.3 # 最新版本可选 latestReleaseDate: 2023-12-01 # 最新发布日期可选 lts: true # 是否为 LTS 版本可选 eoas: 2024-01-01 # 主动支持结束日期可选 eoes: 2026-01-01 # 扩展支持结束日期可选自动更新配置endoflife.date 支持自动更新版本信息你可以配置以下自动更新方法Git 仓库: 从 Git 标签自动获取版本信息Docker Hub: 从 Docker 镜像标签获取版本npm 包: 从 npm 注册表获取版本Maven Central: 从 Maven 中央仓库获取版本DistroWatch: 从 DistroWatch 获取发行版信息例如Ubuntu 的自动更新配置在 products/ubuntu.md 中auto: methods: - distrowatch: ubuntu regex: ^Distribution Releases?: Ubuntu( Linux)? (?Pv1\d\.\d\.?\d)(, (?Pv2\d\.\d\.?\d))?(LTS|, Kubuntu.*)?$ template: {{v1}}{%if v2%}\n{{v2}}{%endif%}验证你的更改使用 JSON Schema 验证endoflife.date 提供了 JSON Schema 来验证产品文件格式。你可以在 product-schema.json 中找到完整的模式定义。对于 VSCode 用户可以配置以下设置{ files.associations: { **/products/*.md: yaml }, yaml.schemas: { ../product-schema.json: products/*.md } }使用脚本验证项目提供了bin/lint-product.sh脚本来检查产品文件格式bin/lint-product.sh products/your-product.md查看预览当你创建 Pull Request 后Netlify 会自动构建预览版本。你可以点击 Details 链接查看包含你更改的网站预览。最佳实践和注意事项1. 遵循指导原则在编写产品描述时请参考项目的 Guiding Principles确保内容风格与网站其他部分一致。2. 使用正确的日期格式所有日期都应使用 UTC 时区格式为YYYY-MM-DD。如果确切日期未知可以使用近似日期。3. 排序规则版本列表应按从新到旧的顺序排列最新的版本放在最前面。4. 标签使用标签应该有意义且一致。查看现有的 标签页面 了解已存在的标签避免创建重复或无用的标签。5. 避免特殊版本不要添加 RC、Alpha、Beta、Nightly 等非稳定版本只包含正式发布版本。常见问题解答Q: 如果产品的 EoL 日期未知怎么办A: 可以将eol字段设置为false表示该版本尚未结束支持。Q: 如何添加自定义字段A: 使用customFields配置可以添加非标准字段如运行时版本或其他自定义信息。Q: 产品图标从哪里获取A: 使用 Simple Icons 中的图标标识符确保图标与产品或供应商相关。Q: 如何测试 API 响应A: 你可以使用提供的脚本测试 API 端点确保你的更改在 API 中正确显示。贡献工作流程总结Fork 仓库- 在 GitHub 上 fork 项目创建分支- 为你的更改创建新分支添加产品- 按照上述步骤创建产品文件验证格式- 使用工具验证文件格式提交更改- 提交并推送到你的分支创建 PR- 发起 Pull Request等待审核- 项目维护者会审核你的更改合并发布- 审核通过后更改会被合并并自动部署获取帮助和支持如果你在贡献过程中遇到问题可以通过以下方式获取帮助查看详细的 CONTRIBUTING.md 文档阅读 HACKING.md 了解本地开发设置在 GitHub Discussions 中提问参考现有产品文件作为示例记住每个贡献都很重要即使只是添加一个产品的信息你也在帮助整个技术社区更好地管理软件生命周期。现在就开始你的第一个贡献吧小贴士: 在提交 Pull Request 之前确保你的产品文件通过了所有验证检查并且产品描述遵循了项目的指导原则。这将大大加快审核和合并的速度【免费下载链接】endoflife.dateInformative site with EoL dates of everything项目地址: https://gitcode.com/gh_mirrors/en/endoflife.date创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考