mirror of
https://github.com/LingCoder/OnJava8.git
synced 2026-08-19 12:33:29 +08:00
add CONTRIBUTING.md
This commit is contained in:
41
CONTRIBUTING.md
Normal file
41
CONTRIBUTING.md
Normal file
@@ -0,0 +1,41 @@
|
||||
## 如何贡献项目
|
||||
|
||||
领取或创建新的 [Issue](https://github.com/lingcoder/OnJava8/issues),如 [issue 14](https://github.com/lingcoder/OnJava8/issues/14) ,添加自己为 `Assignee`。
|
||||
|
||||
在 [GitHub](https://github.com/lingcoder/OnJava8/fork) 上 `fork` 到自己的仓库,如 `user_name/OnJava8`,然后 `clone` 到本地,并设置用户信息。
|
||||
|
||||
```bash
|
||||
$ git clone git@github.com:user_name/OnJava8.git
|
||||
|
||||
$ cd OnJava8
|
||||
```
|
||||
|
||||
修改代码后提交,并推送到自己的仓库,注意修改提交消息为对应 Issue 号和描述。
|
||||
|
||||
```bash
|
||||
# 更新内容
|
||||
|
||||
$ git commit -a -s
|
||||
|
||||
# 在提交对话框里添加类似如下内容 "Fix issue #14: 描述你的修改内容"
|
||||
|
||||
$ git push
|
||||
```
|
||||
|
||||
在 [GitHub](https://github.com/lingcoder/OnJava8/pulls) 上提交 `Pull Request`,添加标签,并邀请维护者进行 `Review`。
|
||||
|
||||
定期使用项目仓库内容更新自己仓库内容。
|
||||
|
||||
```bash
|
||||
$ git remote add upstream https://github.com/lingcoder/OnJava8
|
||||
|
||||
$ git fetch upstream
|
||||
|
||||
$ git rebase upstream/master
|
||||
|
||||
$ git push -f origin master
|
||||
```
|
||||
|
||||
## 排版规范
|
||||
|
||||
本开源书籍排版布局和翻译风格上参考**阮一峰**老师的 [中文技术文档的写作规范](https://github.com/ruanyf/document-style-guide)
|
||||
@@ -78,7 +78,7 @@
|
||||
|
||||
## 翻译说明
|
||||
|
||||
1. 本书排版布局和翻译风格上参考了**阮一峰**老师的 [中文技术文档的写作规范](https://github.com/ruanyf/document-style-guide)
|
||||
1. 本书排版布局和翻译风格上参考**阮一峰**老师的 [中文技术文档的写作规范](https://github.com/ruanyf/document-style-guide)
|
||||
2. 采用第一人称叙述。
|
||||
3. 由于中英行文差异,完全的逐字逐句翻译会很冗余啰嗦。所以本人在翻译过程中,去除了部分主题无关内容、重复描写。
|
||||
4. 译者在翻译中同时参考了谷歌、百度、有道翻译的译文以及《Java编程思想》第四版中文版的部分内容(对其翻译死板,生造名词,语言精炼度差问题进行规避和改正)。最后结合译者自己的理解进行本地化,尽量做到专业和言简意赅,方便大家更好的理解学习。
|
||||
|
||||
@@ -342,7 +342,7 @@
|
||||
<div id="app"></div>
|
||||
<script>
|
||||
window.$docsify = {
|
||||
name: 'OnJava8',
|
||||
name: '《On Java 8》中文版',
|
||||
repo: 'https://github.com/LingCoder/OnJava8',
|
||||
loadSidebar: true,
|
||||
subMaxLevel: 1,
|
||||
|
||||
Reference in New Issue
Block a user