Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 2.33 KB

File metadata and controls

46 lines (30 loc) · 2.33 KB

Contributing Guide

感谢你愿意为 Awesome Full Stack 做出贡献!本仓库旨在收集高质量、可复用的全栈资源。请遵循以下流程,帮助我们保持内容准确、链接可用。

快速开始

  1. Fork 仓库并创建分支,例如 feature/add-supabase-guide
  2. 按照下文步骤修改内容或文档。
  3. 在本地运行必要的检查(如链接验证、Markdown lint)。
  4. 提交 Pull Request(PR)并按照模板填写变更摘要、测试情况与风险评估。

内容贡献规范

  • 链接准确:确保所有链接使用 HTTPS(若可用)并直接指向目标资源主页或官方文档,而非重定向或第三方镜像。
  • 描述精炼:每条目最多 1–2 句描述,突出适用场景、优势或限制。
  • 分类清晰:如果现有分类不合适,请提出 issue 或在 PR 内说明理由后再新建分类。
  • 重复检查:避免添加与现有条目重复的资源,必要时合并描述。
  • 语言:README 默认中文,可在必要处追加英文解释以方便国际贡献者。

修改文档/配置

  • 变更 README.md 时,请同步更新目录 (若适用) 并确认所有 badge、图片、外部脚本可正常加载。
  • 新增自动化或配置文件时,请在 PR 描述中说明用途与运行方式。

报告问题

  • 使用 Bug Report 模版反馈链接失效、描述错误等问题。
  • 使用 Feature / Resource Request 模版建议新增分类、脚本或资源。
  • 如果问题涉及安全或敏感信息,请在 issue 中标注“confidential”并仅提供必要细节,后续可私下沟通。

提交 Pull Request

  • 确保 PR 与对应 issue 关联(若存在)。
  • 按模板填写:概述、测试、截图(如适用)、验证步骤。
  • 如果 PR 会影响大量链接或结构,请先开启草稿 PR,与维护者讨论方案再继续实现。

风格与工具

行为准则

参与者需遵守 Code of Conduct。若发现违规行为,请参考其中的报告方式。

Happy contributing! 🚀