跳转至

贡献指南

欢迎来到 FreeODwiki!

本项目是一个开源开放的项目,致力于创建一个社区共建的OD百科。

温馨提醒

最重要的提示:如欲参与FreeODwiki的Github仓库编辑,请留意你用于编辑的Github账号绑定的邮箱。合作者可以看到你的这个邮箱,可能造成个人信息意外泄露。而且,编辑敏感信息时请务必使用隐私程度较高的邮箱,这样一来,你泄露的邮箱将难以被追踪者用于破解你的个人隐私。

编辑敏感信息时,请一定要保护好个人隐私:不主动问别人的个人信息、不发布自己或别人的个人信息、做好数据脱敏处理。

文档上传/编辑流程

其实,在Github上编辑纯文本项目是无门槛的。只要你会用office、能做ppt、能写word文档,你就能立刻上手Github。对此,请不要有心理压力哦!

编辑文档和提交新文档很简单,不需要电脑。你只需要一部手机和互联网。不涉及任何命令行操作,这里给一个简单的视频教程,点击这里查看

点击这里查看Github官方的如何通过Github网页端进行编辑的教程。

有关文档:

文档 描述
行为守则 请确保你的编辑符合行为守则哦!
如何做出你的第一个贡献 如果你想参与的话,这里有一个简单的教程哦!
药物报告模板&注意事项 投稿药物报告前必读
现有文件夹的描述 编辑时一定要看哦,免得搞混哪些文件夹是用来干什么的!
文档翻译指南和提示词 如果你想从其他网站翻译文档,请务必看这个哦!
Markdown语法指南 如果你不太熟悉Markdown语法,请看这个哦!

请善用Issues

如果你发现本百科存在一些问题,希望邀请社群共同解决这个问题,请善用Github的Issues功能哦!

不过,要是你能自行解决的话,那就更好了......

待完成的项目列表

如果你想参与一些正在进行的项目,这里有一个列表哦!
本页面包含本站尚未完成,但正在完成或准备开始的项目。

  • OD史书 进度:[2023/2026] 有关历史的
  • 配体 进度:[0/1] 有关生命科学的
  • 愈美片 进度: [1/?] 有关药物制剂的
  • 哮喘片 进度: [1/?] 有关药物制剂的
  • 镁剂 进度: [1/?] 有关药物的

编写规范

没有一个规范就会让各个文档像是用固体胶粘起来的一样,或许阅读的各位可能有体会吧。

一般文档规范

其实不必严格遵守,但是最好还是看看吧!

  • 上传新文件时,文件名里面一定不能有空格(包括图片),不然超链接可能会失效;
  • 一个文档的正文第一行建议是大标题(在Markdown中是#)。标题下留空一行,再换一行,加一个返回超链接,便于索引;
  • 标题(指所有在Markdown中以#~######开头的行)上下行留空,不然阅读器可能会将前面或后面的文字和标题粘在一起;
  • 如果想要做的事情无法用markdown完成,可以适当使用html;
  • 特别注意:未经特殊处理的单行换行在markdown文档中只会渲染为一个空格,不会换行;换行必须在一行行末加两个空格<br>;两段文字中留一空行则为分段;
  • 添加新文档或编辑现有文档时,请注意遵守其他同类已有文档的格式
  • 只有在文件/目录下的文件可以是多媒体格式或其他文档格式的,否则一律是.md文件

待补充...

文件夹的使用规范

对于每一类的文档,都需要用一个文件夹专门存储此类文档文件。除非真的有必要且不会引起歧义,否则不要在该文件夹里面再建文件夹,以减少无意义的嵌套。

若无必要,请勿增加文件夹的嵌套。

超链接

超链接让文档内部与文档外部形成一个整体,让整个站点变得易于浏览。如果超链接有不对的地方,务必及时修正;如果一些本应有超链接的部分没有,请补上。

为了兼容FreeODwiki网站使用的mkdocs,用于超链接的文件名和超链接自身不得有英文括号(),否则会无法正常显示。

合作规范

以下给出了FOW在Github上的协作规范

  • 如果想要,你可以直接在Issue里申请合作者权限哦
  • 有合作者权限的人可以直接在main分支中commit,无需pr

感谢你的参与,让 FreeODwiki 更加完善!