Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (40 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

49 lines (40 loc) · 1.89 KB

🎯 贡献指南

感谢你对本项目的兴趣！请阅读以下指南，以确保你的贡献符合项目规范。

🛠️ 代码贡献流程

  1. 克隆仓库之后需要将文档子模块一并拉取 
    git submodule update --init --recursive
  2. 请确认你的代码为Kotlin语言, 本项目仅接受Kotlin语言的代码提交
  3. 添加新的模块/拓展功能时请参考ronebot-onebot-v11的代码设计风格进行设计
  4. 如果你只想更新文档请前往: https://github.com/RTAkland/ROB-Docs 提交PR
  5. 贡献代码之前请先在IDEA-Settings-Copyright-Copyright Profiles中设置文件头 
    Copyright © $today.year RTAkland
Date: $today
Open Source Under Apache-2.0 License
https://www.apache.org/licenses/LICENSE-2.0
  6. 这是贡献指南, 不是使用指南, 使用文档请前往: https://rob.rtast.cn/

English version

Thanks for your interest in this project! Please read the following guidelines to ensure your contribution meets the project specifications.

Code Contribution Process

  1. After cloning the repository, you need to pull the documentation submodule together 
    git submodule update --init --recursive
  2. Please make sure your code is in Kotlin language, this project only accepts Kotlin code
  3. When adding new modules/extensions, please refer to the code design style of ronebot-onebot-v11
  4. If you just want to update the document, please goto https://github.com/RTAkland/ROB-Docs and make a PR
  5. Before you starting coding, please configure the file header in IDEA-Settings-Copyright-Copyright Profiles, like this: 
    Copyright © $today.year RTAkland
Date: $today
Open Source Under Apache-2.0 License
https://www.apache.org/licenses/LICENSE-2.0
  6. This is a contribution guide, not a usage guide. For usage documentation, please visit: https://rob.rtast.cn/