# simple-robot-demo-project

**Repository Path**: ForteScarlet/simple-robot-demo-project

## Basic Information

- **Project Name**: simple-robot-demo-project
- **Description**: 这里是simple-robot的demo项目，你可以使用此项目来学习使用simple-robot框架，或者上传你的代码丰富这里的内容~
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 2
- **Created**: 2020-06-30
- **Last Updated**: 2022-05-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Simple-robot Demo集市

## **这是什么**
这是一个Demo项目，一堆Demo。

是一个基于Simple-robot核心及其组件的示例项目。

## **项目结构**
此项目使用 **`Maven`** 构建，代码存在于[src/main](./src/main)目录下。目录下有一个存在main方法的启动器类/文件。


## **事先声明**
这里的demo仅供参考，且不是Springboot的demo。如果你想要参考Springboot-starter的demo，可以移步https://github.com/ForteScarlet/simple-robot-demo-cqhttp-sbstarter。
不过我个人**建议**先了解过此项目后再去考虑springboot。

## **我要学习**
你可以通过 **clone/fork** 该项目来学习如何使用`simple-robot`框架。

如果依旧有什么疑问，你可以加入群聊`782930037`进行反馈/提问/交流/水群。

## **我要贡献**
你可以向此项目中提交自己的代码(listener)来丰富此项目。

如果你想要提交自己的代码来丰富此项目的内容，你首先需要遵守一些约定：

- **提交到对应的路径中**
java代码提交到java目录下的`love.forte.simbot.demo.listener.${具有辨识度的包名}`中。
所谓具有辨识度的包名，一般是指你的昵称或者这个包下的监听器的功能。
- **命名与注释**
你提交的类/文件一定要有见名知义的命名和详细的说明性注释。

    - 类上要有描述性的doc，其中必须包含类说明文字与`@author`作者信息。
    - 方法上要有描述性的doc，其中必须包含方法功能说明性文字，尽可能有`@param`对参数的解释性描述。(getter/setter除外)


- **代码说明**
除了注释以外，你需要再你所提交的包下使用`README.md`文档的形式对你的代码进行统一描述。这个描述简单一点儿就可以，例如java路径下的基础demo包[base](./src/main/java/love/forte/simbot/demo/listener/base)那样。

- **注意安全**
    - 不要提交含有攻击性、政治性言论内容的文件。
    - 不要提交会泄露个人隐私、侵犯他人隐私的文件。
    - 不要提交含有商业化广告内容的文件。
    - 不要提交会触犯法律、引发纠纷的文件。
    - 不要提交无意义文件。

## **免责声明**

提交到此仓库中的代码可以被任意查看、拷贝、二次使用，如因使用了他人上传的代码而发生了任何不良影响，使用者自行承担导致的任何后果。


## 引路石

核心：https://github.com/ForteScarlet/simple-robot-core

文档地址①：http://simple-robot-doc.forte.love/

文档地址②：https://www.kancloud.cn/forte-scarlet/simple-coolq-doc/content