Initial commit

doc/CI集成.md

@@ -0,0 +1,30 @@
+# 文档说明
+
+作者：侯宾宾
+
+时间：2018-04-24 10:11:43
+
+说明：如何进行项目的持续集成+测试覆盖率
+
+# Travis-CI
+
+[https://www.travis-ci.org](https://www.travis-ci.org) 直接添加此项目
+
+# Coveralls
+
+- 添加项目
+
+[https://coveralls.io/repos/new](https://coveralls.io/repos/new) 直接添加项目
+
+- 生成密匙
+
+```
+travis encrypt COVERALLS_TOKEN=${your_repo_token}
+```
+
+- 添加到文件 
+
+```
+travis encrypt COVERALLS_TOKEN=${your_repo_token} --add
+```
+

doc/issues/v0.0.1.md

@@ -0,0 +1,26 @@
+# 基础类
+
+# 规划好包
+
+所有的包都需要有 `package-info.java`
+
+按照功能点规划包名称。 
+
+# 命名规范
+
+接口 I 开头
+
+工具类 Util 结尾 
+
+常量类 Const 结尾
+
+
+禁止使用缩写，除非非常特殊的 i18n
+
+使用全拼写。
+
+# 使用 junit5 作为测试
+
+复制所有的 paradise 有用基础的类。
+
+gen-test 添加 comment

doc/issues/v0.0.2.md

@@ -0,0 +1,2 @@
+# 反射相关类的添加
+

doc/issues/v0.0.3.md

@@ -0,0 +1,4 @@
+# 补全完善单元测试类。
+
+
+

doc/发布流程.md

@@ -0,0 +1,46 @@
+# 文档说明
+
+本文档用于说明当前项目如何进行发布。
+
+
+# 发布流程
+
+## push to mvn center
+
+```
+mvn clean deploy -P release
+```
+
+## commit to github
+
+```
+git push
+```
+
+## merge to master
+
+```
+git checkout master
+git pull
+git checkout branch
+git rebase master     (用rebase合并主干的修改，如果有冲突在此时解决)
+git checkout master
+git merge branch
+git push
+```
+
+## create new branch & checkout 
+
+```
+git branch release_XXX
+git checkout release_XXX
+```
+
+## modify project version
+
+```
+mvn versions:set -DgroupId=com.github.houbb -DartifactId=paradise* -DoldVersion=1.1.2 -DnewVersion=1.1.3-SNAPSHOT-->
+mvn -N versions:update-child-modules
+mvn versions:commit
+```
+

doc/版本迭代规范.md

@@ -0,0 +1,31 @@
+# 版本类型
+
+x.y.z
+
+x 表示大版本之间的迭代，可能出现前后的不兼容。
+
+y 表示新特性，每次新加一个新特性，都会提升 y 的版本号。
+
+z 表示修复版本号，如果为第一版，则 z=1。后续会依次提升。
+
+## 使用的版本选择
+
+如果在较为正式的环境使用，建议使用 x.y 相同，z 数值最大的版本。
+
+因为这个版本为尽可能修复已知的 bug。
+
+## 新特性
+
+不同版本的新特性，参见变更日志。
+
+# 版本的兼容性
+
+在同一个 x 大版本中，禁止直接删除类信息。
+
+所有的废弃使用 `@Depretectd` 注解、
+
+## 必须有对应的测试
+
+对应的测试信息。
+
+保证代码的正确性。

doc/项目原型.md

@@ -0,0 +1,97 @@
+# 原型创建
+
+- create
+
+```
+$   mvn archetype:create-from-project
+```
+
+- config
+
+```
+~/target/generated-sources/archetype/src/main/resources/META-INF/maven/archetype-metadata.xml
+```
+
+[archetype-descriptor](http://maven.apache.org/archetype/archetype-models/archetype-descriptor/archetype-descriptor.html)
+
+# 文件内容
+
+`~/maven-archetype/target/generated-sources/archetype/src/main/resources/META-INF/maven/archetype-metadata.xml`
+
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<archetype-descriptor xsi:schemaLocation="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0 http://maven.apache.org/xsd/archetype-descriptor-1.0.0.xsd" name="maven-archetype"
+    xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <fileSets>
+
+    <fileSet encoding="UTF-8">
+      <directory></directory>
+      <includes>
+        <include>README.md</include>
+        <include>release.sh</include>
+        <include>release_rm.sh</include>
+        <include>.coveralls.yml</include>
+        <include>.travis.yml</include>
+        <include>.gitignore</include>
+        <include>LICENSE.txt</include>
+      </includes>
+    </fileSet>
+
+    <fileSet packaged="true" encoding="UTF-8">
+      <directory>src/main/java</directory>
+      <includes>
+        <include>**/*.md</include>
+      </includes>
+    </fileSet>
+    <fileSet encoding="UTF-8">
+      <directory>src/main/resources</directory>
+      <includes>
+        <include>**/*.md</include>
+      </includes>
+    </fileSet>
+    <fileSet encoding="UTF-8">
+      <directory>src/test/java</directory>
+      <includes>
+        <include>**/*.md</include>
+      </includes>
+    </fileSet>
+
+    <fileSet encoding="UTF-8">
+      <directory>doc</directory>
+      <includes>
+        <include>**/*.md</include>
+      </includes>
+    </fileSet>
+
+  </fileSets>
+</archetype-descriptor>
+```
+
+- install
+
+```
+$   cd target/generated-sources/archetype/
+$   mvn install
+```
+
+
+- use
+
+```
+$   mkdir /tmp/archetype
+$   cd /tmp/archetype
+$   mvn archetype:generate -DarchetypeCatalog=local
+```
+
+## 注意
+
+`.gitignore` 文件默认没有添加，需要手动添加。
+
+`*.iml` 文件是多余的，手动删除
+
+
+
+
+