跳到主要内容

如何贡献代码

作为一个开源项目,Knife4j 的成长离不开社区贡献者的支持和参与。我们非常欢迎广大社区用户为 Knife4j 贡献代码、文档或改进网站,在此过程中,我们愿意为您提供必要的支持。

社区贡献

开源贡献

Knife4j仓库结构说明

  • knife4j-desktop:Knife4j的独立中间件,基于Java编写,可以独立运行渲染OpenAPI规范文件
  • knife4j-doc: 官网文档,基于Docusaurus进行编写
  • knife4j-vue: 前端源码,基于Vue框架编写
  • knife4j: Java端代码,包括所有公开使用的starter组件封装

指导方针

  • 在开始进行功能或者修复Bug之前,事先请在Github、Gitee平台上搜索与之相关的功能是否已经实现,或着也可以通过Github、Gitee平台的issue与我们取得联系。以确保该任务没有其他人在处理,避免重复操作。
  • 所有功能可通过Github或者Gitee的issues进行沟通讨论,避免浪费大家的时间。
  • 如果是重大功能更新,建议你在编码开发的同时,将该功能的设计、思想、实现以及使用说明通过文档进行输出。最好是合并在Knife4j的官方文档上
  • 提交PR时,需要将PR请求提交到dev分支!!!