跳转至

贡献指南

感谢你来到本页面——这说明你是一个有奉献精神的人。本网站是由众多志愿者一起义务运营的,但仅凭目前的人手还不足以支撑我们的日常维护和内容产出。我们希望有更多愿意贡献自己知识和技术的志愿者加入我们。

在正式参与之前,你需要了解这些东西。

贡献范围

你可以对本站所有内容作出贡献,包括但不限于:编写和编辑文档代码贡献内容审查外语翻译工作设计贡献网站维护文档格式化web前端开发

在开源社区,每个成员的贡献都是独一无二的,无论大小。通过共同努力,我们可以创造出更加强大、更有影响力的项目。记住,你的每一分努力都是推动项目前进的动力

Warning

本站所有内容均遵照CC BY-NC 4.0协议开源,故若为此网站作出贡献,则默认所贡献的内容也以相同协议开源。

质量标准

在进行贡献之前,请确保你了解如何使用Markdown。这并不代表你需要精通Markdown这种标记语言。你只需要了解一些Markdown的特性与一些常用的语法。学习Markdown的基本用法通常只需要花费不到半小时。(Markdown扫盲)

本站利用docsify工具,将Markdown文件实时渲染成html供浏览器显示。故你不需要学习复杂的html的各种语法规则,只需要使用一些简单的“所见即所得”的Markdown编辑器(例如typora)来编写你的文档。文档入库之后就可以按照文档的排版格式在网站中展示。

文档具体的格式要求,请参看格式手册

同时,为了让本站有意义,你的内容应符合以下标准:

  • 准确性:请确保贡献的内容在事实上是准确无误的,避免误导读者。
  • 清晰性:你的文档应当语言清晰、条理分明,逻辑性强,便于读者理解。
  • 文档风格:文档应排版适当、可读性强。文档中可能使用的格式包括但不限于:标题、LaTeX公式。
  • 完整性:贡献的内容应尽可能全面,涵盖相关主题的所有重要方面。
  • 最新性:信息应保持最新,及时更新过时的内容。
  • 技术规范:对于代码贡献,应遵循项目的技术规范和编码标准。
  • 版权合规:所有贡献的内容都应遵守版权法规,不侵犯他人的知识产权。
  • 引用和参考:对于引用的内容,应提供准确的来源和参考文献。
  • 语言和文化敏感性:避免使用可能引起误解或冒犯的语言和图像。

贡献方式

在确认好你的内容符合规范之后,你就可以正式作出贡献了。这里提供了几种可能的贡献方式。

在GitHub中进行文档编辑

如果你熟悉GitHub,请点击每篇文章右上方的编辑按钮,打开本站对应的文件参与编辑。编辑完成后,请提交pull request.

如果你没有使用过GitHub,可以参看如何使用GitHub

在GitHub中提起Issues

你可以通过Issues提出文档改进的建议,或者讨论更复杂的编辑事宜。

本地编辑

如果你实在不会使用GitHub,你可以使用本地编辑的形式。你可以在本地使用文本编辑器(例如:NotePad++,typora)撰写文档。编辑完成后,你可以通过邮件的方式将markdown文档发送给管理员(点击这里向管理员发送邮件,如果浏览器或系统不支持mailto命令,可以手动复制地址hownotfound@gmail.com)。请注意,请在发送邮件的同时,附带上你的身份信息(可以是实名、也可以是虚拟的身份),以便我们在文章中署名。

校园张贴栏

如果你的学校有Starship的文稿收集志愿者,那么你甚至可以在校园张贴栏发表你的文章。如果我们的文稿收集志愿者看到了你的文章,会收录你的文章并在文章下方留下提示。

请注意,如果你想通过这种方式发表文章,请你一定记得在文章开头留下我们网站的名字和网址,以便志愿者进行识别。请在张贴的同时,留下你的身份信息(可以是实名、也可以是虚拟的身份),以便我们在文章中署名。

目前支持:绵阳东辰学校弘毅楼绵阳东辰高中广雅楼

加入我们的讨论群

你可以加入我们的QQ讨论群群号:959888475。你可以和群里的志愿者们一起讨论,也可以通过群聊联系管理员提交你的内容。

通过各种媒介宣传我们的网站

你可以通过社交媒体、博客、内容营销、口头推荐甚至校园公告栏的形式帮助宣传我们的网站。这对于吸引更多用户和志愿者加入社区有着巨大的作用。

都看到这里了,还不赶紧行动起来。

- The End -