mirror of
https://github.com/Snailclimb/JavaGuide
synced 2025-06-16 18:10:13 +08:00
33 lines
1.8 KiB
Markdown
33 lines
1.8 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/)
|
||
- [中文排版需求](https://www.w3.org/TR/clreq/)
|
||
|
||
如果要提 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)。
|
||
|
||
另外，你可以参考学习别人的文章，但一定一定一定不能复制粘贴别人的内容，努力比别人写的更容易理解，用自己的话讲出来，适当简化表达，突出重点！
|