Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
328 lines (220 loc) · 6.45 KB

CONTRIBUTING.md

File metadata and controls

328 lines (220 loc) · 6.45 KB

贡献指南

感谢您对本仓库的关注和贡献意愿！我们欢迎所有形式的贡献，包括但不限于：

  • ✍️ 新增疾病知识内容
  • 🔍 完善现有内容
  • 🐛 修正错误或过时信息
  • 📝 改进文档结构和排版
  • 🌐 翻译内容到其他语言
  • 💡 提供建议和意见

如何贡献

1. 新增疾病内容

步骤 1：使用内容模板

请使用我们的标准内容模板（见下文），确保内容的格式和结构统一。

步骤 2：创建新文件

在相应的分类目录下创建新的 Markdown 文件。

示例：

# 在心血管分类下创建高血压文档
cardiovascular/hypertension.md

步骤 3：填写内容

按照模板填写疾病相关信息，确保内容准确、完整。

步骤 4：添加到目录索引

更新相应的 README.md，添加新文档的链接。

2. 修改现有内容

步骤 1：Fork 仓库

如果您还没有 Fork，请先 Fork 本仓库。

步骤 2：创建分支

git checkout -b feature/your-feature-name
# 或
git checkout -b fix/issue-number

步骤 3：修改内容

在您的新分支上进行修改。

步骤 4：提交修改

git add .
git commit -m "简短描述您的修改"

步骤 5：提交 Pull Request

将您的修改推送回您的 Fork，然后提交 Pull Request 到主仓库。

内容质量标准

✅ 我们期望的内容

  1. 准确性

    • 信息来源可靠，优先引用权威医学机构
    • 避免错误或误导性的信息
    • 标注信息来源和更新时间

  2. 完整性

    • 涵盖疾病的各个方面（病因、症状、诊断、治疗、预防）
    • 内容结构清晰，易于理解

  3. 可读性

    • 使用简洁明了的语言
    • 避免过度专业术语，或对术语进行解释
    • 使用适当的格式（标题、列表、表格等）提升可读性

  4. 时效性

    • 确保信息是最新的
    • 定期更新过时内容
    • 标注最后更新日期

❌ 我们不接受的内容

  1. 明显错误的信息

    • 与权威医学指南相悖的内容
    • 缺乏证据支持的夸大宣传

  2. 商业推广

    • 某些产品或服务的广告
    • 带有商业目的的软文

  3. 版权内容

    • 直接复制受版权保护的内容
    • 未经授权的转载

  4. 误导性信息

    • 可能导致读者延误就医的内容
    • 过度承诺疗效的内容

标准内容模板

请使用以下模板作为新增内容的起点：

# 疾病名称

> 简要描述疾病的特点和影响

> ⚠️ **重要提示**：本内容仅供科普参考，不能替代专业医疗建议。请阅读仓库中的[免责声明](../DISCLAIMER.md)了解更多详情。

---

**最后更新**：YYYY-MM-DD
**分类**：[脑类/消化类/心血管类/呼吸类/内分泌类/骨骼肌肉类/其他]

## 疾病概述

[简要介绍疾病的基本信息，包括定义、流行病学等]

## 症状表现

### 主要症状
- 症状1
- 症状2
- 症状3

### 伴随症状
- 伴随症状1
- 伴随症状2

## 病因与风险因素

### 常见原因
- 原因1
- 原因2

### 风险因素
- 风险因素1
- 风险因素2

## 诊断方法

### 临床表现
[典型的临床特征]

### 辅助检查
- 检查方法1
- 检查方法2

### 诊断标准
[权威指南的诊断标准]

## 治疗方案

### 非药物治疗
[生活方式干预、物理治疗等]

### 药物治疗
| 药物名称 | 作用机制 | 用法用量 | 注意事项 |
|---------|---------|---------|---------|
| 药物A | 机制1 | 用法1 | 注意1 |
| 药物B | 机制2 | 用法2 | 注意2 |

### 手术治疗（如适用）
[手术指征、方式等]

## 预防措施

- 预防措施1
- 预防措施2

## 需要就医的症状

⚠️ 出现以下情况应立即就医：
- 症状1
- 症状2

## 特殊人群注意事项

### 儿童
[儿童的特殊考虑]

### 老年人
[老年人的特殊考虑]

### 孕妇
[孕妇的特殊考虑]

## 参考资料

### 权威指南
- [指南名称 - 链接](URL)

### 专业网站
- [网站名称 - 链接](URL)

### 科普文章
- [文章标题 - 来源 - 链接](URL)

---

## 更新日志

- **YYYY-MM-DD**：[更新内容描述]
- **YYYY-MM-DD**：[初始版本]

分支命名规范

使用清晰的分支名称，便于追踪：

  • 新增内容：feature/disease-name
  • 修复问题：fix/issue-number 或 fix/description
  • 更新内容：update/disease-name
  • 文档改进：docs/improvement-description

Commit 信息规范

使用清晰、简洁的 Commit 信息：

新增：添加高血压疾病知识
修复：修正便秘文档中的药物用法错误
更新：更新脑梗文档的最新治疗指南
文档：统一格式和排版

PR（Pull Request）规范

PR 标题

简洁明了，描述清楚本次修改的内容。

PR 描述

请包括：

  1. 修改内容：简述您做了哪些修改
  2. 修改原因：为什么做这些修改
  3. 相关 Issue：如果有相关 Issue，请关联
  4. 测试情况：如果是代码修改，请说明测试情况

PR 检查清单

在提交 PR 前，请确认：

  • 已阅读并遵守贡献指南
  • 已使用标准内容模板
  • 内容信息准确，来源可靠
  • 已更新相关索引和链接
  • 已更新最后更新时间
  • 已进行拼写和语法检查
  • Markdown 格式正确

代码风格

虽然本仓库主要是 Markdown 文档，但如果有代码部分，请遵循：

  • 使用 2 个空格缩进
  • 每行不超过 100 个字符
  • 使用有意义的变量和函数名

资源来源

可靠的信息来源

我们建议优先从以下来源获取信息：

  1. 权威医学指南

    • 中华医学会
    • 美国胃肠病学会（AGA）
    • 世界卫生组织（WHO）

  2. 专业医学网站

    • 梅奥诊所（Mayo Clinic）
    • WebMD
    • 丁香医生（中国）

  3. 学术期刊

    • 中华医学杂志
    • The Lancet
    • NEJM

需谨慎的来源

  • 个人博客
  • 社交媒体
  • 商业网站的健康资讯

讨论与交流

提交 Issue

如果您发现任何问题或有任何建议，欢迎提交 Issue。

讨论区

在提交 PR 时，可以使用 GitHub 的讨论区进行交流。

联系方式

如有重要事项，请通过 GitHub Issues 联系。

许可证

通过提交 Pull Request，您同意您的贡献将按照 MIT License 进行许可。

致谢

感谢所有贡献者对本仓库的支持！

最后更新：2026-03-09