Skip to content

Latest commit

 

History

History
116 lines (86 loc) · 5 KB

README.md

File metadata and controls

116 lines (86 loc) · 5 KB
Raw

🚀 A Cutting-edge Tool For Rapid Java Web Development.

👉 http://xuewei.world 👈

github star

📚简介

XwFast 是专为 Java Web 开发的基于 Spring 系列框架封装的黑科技脚手架，通过诸多实用工具类/组件的使用，旨在帮助开发者快速、便捷地完成各类开发任务。这些封装的工具组件涵盖了基础增删查改接口、邮件客户端、短信客户端、等一系列操作，可以满足各种不同的开发需求。

🍺理念

XwFast 旨在解放程序员生产力，用最少的代码做最多的事，将您的宝贵时间放在复杂业务和提升自我上，简单的事就交给 XwFast 吧！

🛠️组件

XwFast 采用了组件式的架构设计，您可按需引入所需要的模块，当然如果您是成年人，“成年人不做选择，我全都要！”，您可直接引入 xw-fast-all。

模块 介绍
xw-fast-all 关于 XwFast 的全部内容
xw-fast-core 核心，包括的各种工具类、异常定义等
xw-fast-crud 封装基础增删查改的基础接口、基础实体的封装
xw-fast-web 封装一些开箱即用的 Spring 组件
... ...

📦安装

🍊Maven

在项目的 pom.xml 的 dependencies 中加入以下内容：

<!-- 引入 Xw-Fast -->
<dependency>
    <groupId>world.xuewei</groupId>
    <artifactId>xw-fast-all</artifactId>
    <version>1.0.1</version>
</dependency>

📥下载jar

点击链接，下载 xw-fast-all-X.X.X.jar 即可，Maven中央库。

📝文档

  • 中文文档：作者正在紧锣密鼓的撰写，敬请期待。
  • 英文文档：作者正在紧锣密鼓的撰写，敬请期待。

🏗️添砖加瓦

🎋分支说明

XwFast 的源码分为两个分支，功能如下：

分支 说明
main 主分支，release 版本使用的分支，与中央库提交的 jar 一致，不接收任何 pr 或修改
dev 开发分支，默认为下个版本的 SNAPSHOT 版本，接受修改或 pr

🐞提供bug反馈或建议

提交问题反馈请说明正在使用的 JDK 版本、XwFast 版本和相关依赖库版本。

Issues · XwFast

🧬贡献代码的步骤

  1. 在 Github 上 fork 项目到自己的 repo
  2. 把 fork 过去的项目也就是你的项目 clone 到你的本地
  3. 修改代码（记得一定要修改 dev 分支）
  4. commit 后 push 到自己的库（dev分支）
  5. 登录 Github 在你首页可以看到一个 Pull Request 按钮，点击它，填写一些说明信息，然后提交即可
  6. 等待维护者合并

📐PR遵照的原则

XwFast 欢迎任何人为 XwFast 添砖加瓦，贡献代码，不过维护者是一个强迫症患者，为了照顾病人，需要提交的 pr（pull request）符合一些规范，规范如下：

  1. 注释完备，尤其每个新增的方法应按照 Java 文档规范标明方法说明、参数说明、返回值说明等信息，必要时请添加单元测试，如果愿意，也可以加上你的大名。
  2. XwFast 代码的缩进按照默认（tab）缩进，所以请遵守（不要和我争执空格与 tab 的问题，这是一个病人的习惯）。
  3. 请 pull request 到 dev 分支。
  4. 我们如果关闭了你的 issue 或 pr，请不要诧异，这是我们保持问题处理整洁的一种方式，你依旧可以继续讨论，当有讨论结果时我们会重新打开。