Skip to content

Commit

Permalink
Update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
reeze committed Feb 20, 2013
1 parent 50bbbd1 commit 6524505
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 22 deletions.
13 changes: 8 additions & 5 deletions README.markdown
@@ -1,15 +1,18 @@
# 深入理解PHP内核(Thinking In PHP Internal)

TIPI项目是一个自发项目, 项目主要关注PHP的内部实现, 以及PHP相关的方方面面, 该项目包括《深入理解PHP内核》这本书,
以及一些相关的PHP项目,例如一些PHP扩展及研究项目.
TIPI项目是一个自发项目, 项目主要关注PHP的内部实现, 以及PHP相关的方方面面,
该项目包括《深入理解PHP内核》这本书,以及一些相关的PHP项目,例如一些PHP扩展及研究项目.

前往这里阅读在线版本的 [深入理解PHP内核(TIPI)][project-url]

## 关于如何加入项目组
很多同学留言询问怎么加入项目,其实很简单:
1. fork这个项目
2. 提交Pull Requests
3. 在一段时间后,如果对项目还有热情可以直接给你开放提交权限


## 1. 下载
本站所有内容托管在github<http://github.com/reeze/tipi>上,如果你电脑上安装了[git](http://git-scm.com/)最好,没有的话也不碍,
在页面右右上角可以下载到项目完整的压缩包,选择你喜欢的压缩格式即可。
本站所有内容托管在github<http://github.com/reeze/tipi>上,如果你电脑上安装了[git](http://git-scm.com/)最好,没有的话也不碍,在页面右右上角可以下载到项目完整的压缩包,选择你喜欢的压缩格式即可。

## 2. 安装
将项目解压,目录结构中web目录即为项目的web根目录,项目不强制将你的Web服务器根目录设为web目录的路径,
Expand Down
25 changes: 12 additions & 13 deletions RELEASE_PROCESS
Expand Up @@ -4,29 +4,28 @@


### 版本命名
命名以章节为版本号例如:V0.1.13则表示目前完出到了
命名以章节为版本号例如:V0.1.13则表示目前完出到了:第一章,第13小节

### 分支
目前我们主要使用**master**作为主线分支. 而每次的发布都是从**release**分支进行的.
目前我们主要使用**master**作为主线分支而每次的发布都是从**release**分支进行的

### tag管理
每次在发布新版本的时候需要将当前release分支打上tag,例如: RELEASE_2011-03-20,
每次在发布新版本的时候需要将当前release分支打上tag例如: RELEASE_2011-03-20
或者使用类似RELEASE_2011-03-20_V0.1.4_PDF_EDITION_ADDED



## 发布时机
在以下情况下我们需要发布一个新的版本:
在以下情况下我们需要发布一个新的版本

### 出现**错误**
在发现内容上出现**错误**的时候需要马上进行升级发布, 错误的内容可能会对读者产生误导, 一旦发现需要马上进行修复.
修复错误的时候需要给予release分支新建一个本地bugfix分支,修复完成后再合并入release分支,不允许直接基于master分支进行修改,
因为这样可能会将没有讲过review的内容合并到线上.
在发现内容上出现**错误**的时候需要马上进行升级发布 错误的内容可能会对读者产生误导, 一旦发现需要马上进行修复
修复错误的时候需要给予release分支新建一个本地bugfix分支修复完成后再合并入release分支,不允许直接基于master分支进行修改,
因为这样可能会将没有讲过review的内容合并到线上

### 小节完成
每完成一小节我们都可以进行发布. 编写者完成后在邮件组或者gtalk上通知一下大家, 请各位review,一般提交后2天内进行review,
完成后merge到release分支.
每完成一小节我们都可以进行发布 编写者完成后在邮件组或者gtalk上通知一下大家 请各位review
一般提交后2天内进行review,完成后merge到release分支

### 完成一章
完成一章属于一个较大的升级. 完成一章并不是简单的编写完一整章, 首先我们需要对以前所有编写的内容进行重新Review,
解决以前内容中出现的错别字以及内容上的重新调整优化. 内容不够详细则不允许发布,
完成一章属于一个较大的升级。 完成一章并不是简单的编写完一整章,
首先我们需要对以前所有编写的内容进行重新Review,解决以前内容中出现的错别字以及内容上的重新
调整优化。 内容不够详细则不允许发布.
4 changes: 0 additions & 4 deletions WRITTEN_STANDARDS
Expand Up @@ -26,13 +26,9 @@
对于没有明显先后顺序的列表使用无序列表, 否则使用有序列表。




## 标点符号的使用
* 半角全角的使用: 在中文段落上下文中使用全角符号,如果是在英文上下文环境则统一使用半角符号。



## 代码块的编写


Expand Down

0 comments on commit 6524505

Please sign in to comment.