跳转至

贡献指南 (Contributing Guide)

感谢你对哲学家百科全书项目的关注!我们欢迎任何形式的贡献。

参与本项目即表示你同意遵守我们的 行为准则(Contributor Covenant v2.1)。


🚀 本地开发环境搭建

前置要求

  • Python 3.9+
  • Git

步骤

# 1. Fork 本仓库
# 2. 克隆你的 Fork
git clone https://github.com/YOUR_USERNAME/philosopher-encyclopedia.git
cd philosopher-encyclopedia

# 3. 安装依赖
pip install -r requirements.txt

# 4. 本地预览站点
zensical serve
# 访问 http://127.0.0.1:8000 查看效果

# 5. (可选)运行一致性校验
python scripts/gen_index.py

# 6. 创建新分支并提交
git checkout -b my-change
git add .
git commit -m "描述你的更改"
git push origin my-change

# 7. 在 GitHub 上创建 Pull Request

目录结构说明

philosopher-encyclopedia/
├── requirements.txt        # Python 依赖(pip install -r)
├── mkdocs.yml              # Zensical 站点配置(兼容 MkDocs 格式)
├── philosophers/           # 哲学家条目(核心内容)
│   ├── index.md            # 总览索引
│   ├── camus.md            # 示例条目
│   └── ...
├── docs/                   # 补充文档
│   ├── schools.md          # 流派概览
│   └── timeline.md         # 时间线
├── scripts/
│   └── gen_index.py        # 一致性校验(只读,不改文件)
└── template.md             # 新条目模板

🎯 如何贡献

1. 添加新哲学家条目

步骤: 1. Fork 本仓库 2. 在 philosophers/ 目录下创建新的 Markdown 文件(文件名用英文名,如 plato.md) 3. 使用 template.md 作为模板 4. 运行 python scripts/gen_index.py 校验一致性(只读检查,不需要预提交) 5. 更新 mkdocs.yml:在 nav.哲学家 中为新条目添加导航链接 6. 更新 philosophers/index.md:在对应学习阶段表格中添加一行 7. 提交 Pull Request

要求: - 条目需包含:生平、核心思想、代表作品、历史影响四个基本部分 - 引用的观点需注明来源 - 保持客观中立的学术态度 - 中文写作,语言流畅易懂

2. 完善现有条目

如果发现现有条目有: - 事实错误 - 遗漏重要信息 - 表述不清 - 缺少参考资料

欢迎提交 Issue 或 Pull Request 进行修正。

3. 改进项目结构

  • 提出新的分类方式
  • 添加索引或导航
  • 优化 README 或文档

📝 条目写作规范

文件命名

  • 使用英文小写字母
  • 多个单词用连字符连接
  • 示例:friedrich-nietzsche.md, confucius.md

内容结构

请参考 template.md,包含以下部分: 1. 基本信息表格 2. 生平时间线 3. 核心思想 4. 代表作品 5. 对后世的影响 6. 经典名言 7. 延伸阅读

引用规范

  • 直接引用需注明出处(著作名称 + 页码)
  • 推荐书籍需注明作者、译者、出版社
  • 在线资源需提供可访问的链接

语言风格

  • 使用现代汉语,避免过于学术化的术语(或提供解释)
  • 保持客观,避免主观评价
  • 尊重不同哲学观点,不贬低任何流派

🚀 提交流程

方式一:GitHub Web 界面(推荐新手)

  1. 点击文件右上角的铅笔图标进行编辑
  2. 修改完成后点击 "Commit changes"
  3. 提交 Pull Request

方式二:本地开发(推荐熟练用户)

# 1. Fork 本仓库
# 2. 克隆你的 Fork
git clone https://github.com/YOUR_USERNAME/philosopher-encyclopedia.git
cd philosopher-encyclopedia

# 3. 创建新分支
git checkout -b add-new-philosopher

# 4. 添加或修改文件
# ... 编辑文件 ...

# 5. (可选)运行一致性校验
python scripts/gen_index.py

# 6. 提交更改
git add .
git commit -m "添加 XXX 哲学家条目"

# 7. 推送到你的 Fork
git push origin add-new-philosopher

# 8. 在 GitHub 上创建 Pull Request

💡 选题建议

✅ 已收录(48 位)

本项目已涵盖以下哲学家(按学习路径分阶):

第一阶:存在主义入门 加缪、萨特、克尔凯郭尔、尼采、叔本华、胡塞尔、海德格尔、波伏娃、梅洛-庞蒂

第二阶:扩展与深化 雅斯贝尔斯、陀思妥耶夫斯基、黑格尔、马克思、阿伦特、弗洛姆、福柯、德里达、罗素、维特根斯坦

第三阶:古希腊、中国与近代哲学源头 老子、庄子、孔子、孟子、赫拉克利特、苏格拉底、柏拉图、亚里士多德、笛卡尔、休谟

第四阶:从近代政治哲学到现代开放社会 康德、霍布斯、洛克、卢梭、边沁、密尔、杜威、波普尔、莱布尼茨、罗尔斯

第五阶:中国墨家、理性主义顶峰与分析哲学发端 墨子、斯宾诺莎、弗雷格

第六阶:中世纪教父哲学、经验主义启蒙 奥古斯丁、阿奎那、培根

📌 优先添加的哲学家

以下哲学家对哲学史有重大影响,尚未收录,欢迎贡献:

优先级 哲学家 流派/所属 推荐理由
★★★ 尼科洛·马基雅维利 文艺复兴·政治哲学 现代政治哲学的起点,《君主论》
★★★ 王阳明 中国·宋明心学 心学集大成者,"知行合一"
★★★ 尤尔根·哈贝马斯 法兰克福学派 当代最重要的在世哲学家,交往行为理论
★★☆ 威廉·詹姆斯 实用主义 实用主义奠基人,《心理学原理》
★★☆ 约翰·戈特利布·费希特 德国古典哲学 康德与黑格尔的中介,《知识学》
★★☆ 格奥尔格·威廉·弗里德里希·谢林 德国古典哲学 德国观念论三巨头之一
★★☆ 查尔斯·桑德斯·皮尔士 实用主义 实用主义创始人,符号学先驱
★★☆ G.E.摩尔 分析哲学 常识哲学,元伦理学开端
★★☆ 米歇尔·德·蒙田 文艺复兴·怀疑论 随笔文体开创者,"我知道什么?"
★☆☆ 威拉德·冯·奥曼·蒯因 分析哲学 经验论两个教条,分析哲学转折
★☆☆ 托马斯·库恩 科学哲学 《科学革命的结构》,范式理论
★☆☆ 朱熹 中国·宋明理学 理学集大成者,"存天理灭人欲"
★☆☆ 保罗·利科 现象学·解释学 法国现象学第三代,叙事认同
★☆☆ 西奥多·阿多诺 法兰克福学派 批判理论,《启蒙辩证法》

📋 如何选择

  • 对哲学史有重大影响
  • 思想具有现实意义
  • 有可靠的参考资料

❓ 常见问题

Q: 我对哲学不太了解,可以贡献吗?
A: 当然可以!你可以: - 修正错别字或格式问题 - 添加参考资料链接 - 翻译外文资料 - 提出改进建议

Q: 如何避免事实错误?
A: - 参考多部权威著作 - 查阅学术资料(斯坦福哲学百科、互联网哲学百科等) - 在提交前请他人审阅

Q: 可以添加当代哲学家吗?
A: 可以,但需满足: - 对哲学领域有公认的重大贡献 - 有代表性的著作 - 思想已经过一定时间的检验

Q: 添加新哲学家时需要更新哪些文件?
A: 需要同步更新以下文件: 1. philosophers/ 下创建新 .md 文件 2. mkdocs.yml — 在 nav.哲学家 中添加导航链接 3. philosophers/index.md — 在对应学习阶段表格中添加一行

Q: 提交前必须运行 gen_index.py 吗?
A: CI 中的 validate-entries.yml 会自动运行 python scripts/gen_index.py 做一致性校验,检查必需章节是否齐全、新添加的哲学家是否在 mkdocs.yml 中注册等。脚本是只读的,不会修改任何文件,放心运行。


📧 联系方式

如有疑问,欢迎: - 提交 Issue - 邮件联系:GTX950L(通过 GitHub 个人主页获取)


再次感谢你的贡献! 🙏