Explorar el Código

Merge remote-tracking branch 'origin/master'

zhouhao hace 7 años
padre
commit
f59b5b78dd
Se han modificado 3 ficheros con 122 adiciones y 0 borrados
  1. 46 0
      CODE_OF_CONDUCT.md
  2. 18 0
      CONTRIBUTING.md
  3. 58 0
      docs/user-guide/index.md

+ 46 - 0
CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at admin@hsweb.me. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

+ 18 - 0
CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# 贡献你的代码
+1. fork 本仓库
+2. 修改,增加代码
+3. 执行`mvn test`通过
+4. 提交`pull request`
+5. 坐等审查
+6. 合并
+
+# BUG
+如果知道导致bug的位置,你可以直接修改后`pull request`,也可以勾出bug所在位置,然后提交[issues](https://github.com/hs-web/hsweb-framework/issues/new)
+并 `@zhou-hao`,label 选择`bug`.我们会尽快解决.
+
+# 需求&优化
+你可以通过issues提交你希望`hsweb`增加的特性以及功能优化,并可以在 [projects](https://github.com/hs-web/hsweb-framework/projects)中查看`hsweb`的开发进展以及计划.
+
+# 社区&交流
+你可以通过提交`issues`或者加入官方QQ群:[515649185](http://shang.qq.com/wpa/qunwpa?idkey=3d66b5dd14991d7645af694e7649b373f3a9ce1216131094c78cb2348d542c41)
+以及发送邮件和我们取得联系.

+ 58 - 0
docs/user-guide/index.md

@@ -0,0 +1,58 @@
+# hsweb 用户手册
+
+## 框架基础设施
+主要为框架提供的常用工具
+1. 增删改查
+    * 通用增删改查
+    * 动态条件
+    * 表关联动态条件
+    * 拓展字段
+2. 权限控制
+    * 常用API
+    * 使用注解声明权限控制
+    * 自定义声明权限控制
+    * 拓展数据权限控制
+3. 访问日志
+    * 声明记录访问日志
+    * 监听访问日志
+    * 日志序列化
+4. 动态数据源
+    * 在配置文件中添加动态数据源
+    * 通过自定义,在数据库或其他地方添加动态数据源
+    * 注解方式切换动态数据源
+    * 编程方式切换动态数据源
+5. 常用并发工具
+    * 锁,分布式锁
+    * 计数器
+    * 异步任务,批量任务,事务
+6. 消息封装
+    * 消息队列
+    * websocket
+7. 其他工具
+    * 智能日期格式化
+    * excel,word操作
+    * 动态脚本引擎
+
+## 系统功能
+主要为框架实现的常用功能
+1. 权限配置
+2. 组织架构
+    * 组织架构数据权限控制
+    * 人员关系
+3. 数据字典
+4. 动态表单
+   * 设计表单
+   * 增删改查
+   * 验证器
+   * 触发器
+5. 文件上传下载
+    * 本地文件上传下载
+    * 文件秒传
+    * 静态文件上传下载
+    * 拓展其他文件上传
+6. 定时调度
+    * 动态脚本编写定时调度任务
+    * 集群下指定固定节点执行任务
+7. 动态脚本
+8. 工作流引擎
+    * flowable工作流设计器