mirror of
https://github.com/Snailclimb/JavaGuide
synced 2025-06-16 18:10:13 +08:00
28 lines
1.4 KiB
Markdown
28 lines
1.4 KiB
Markdown
---
|
||
title: 贡献指南
|
||
category: 走近项目
|
||
icon: guide
|
||
---
|
||
|
||
欢迎参与 JavaGuide 的维护工作，这是一件非常有意义的事情。详细信息请看：[JavaGuide 贡献指南](https://zhuanlan.zhihu.com/p/464832264) 。
|
||
|
||
你可以从下面几个方向来做贡献：
|
||
|
||
- 笔记内容大多是手敲，所以难免会有笔误，你可以帮我找错别字。
|
||
- 很多知识点我可能没有涉及到，所以你可以对其他知识点进行补充。
|
||
- 现有的知识点难免存在不完善或者错误，所以你可以对已有知识点进行修改/补充。
|
||
|
||
一定一定一定要注意 **排版规范**：
|
||
|
||
- [中文文案排版指北 - GitHub](https://github.com/sparanoid/chinese-copywriting-guidelines)
|
||
- [写给大家看的中文排版指南 - 知乎](https://zhuanlan.zhihu.com/p/20506092)
|
||
- [中文文案排版细则 - Dawner](https://dawner.top/posts/chinese-copywriting-rules/)
|
||
- [中文技术文档写作风格指南](https://github.com/yikeke/zh-style-guide/)
|
||
|
||
如果要提 issue/question 的话，强烈推荐阅读下面这些资料：
|
||
|
||
- [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)
|
||
- [《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545)
|
||
- [《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/~sgtatham/bugs-cn.html)
|
||
- [《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393)。
|