BuildAdmin

Appearance

贡献代码 ​

开源需要大家一起来支持，支持的方式有很多种，比如使用、推荐、写教程、保护生态、贡献代码、回答问题、分享经验等；欢迎您加入我们！

操作流程 ​

BuildAdmin 的代码仓库地址如下：

1. Fork 和 克隆

首先进入 BuildAdmin 仓库网页，Fork 仓库到自己的账号下。
然后克隆 Fork 的仓库到本地，然后进入buildadmin目录

bash
git clone https://gitee.com/<yourname>/buildadmin.git
cd buildadmin

2. 安装后端依赖和启动安装服务

bash
composer install
php think run

浏览器访问：127.0.0.1:8000，根据引导完成安装。

3. 编写代码并测试

  • 在本地新增功能或者修复 Bug，进行测试，并将代码 commit 到本地 git 仓库；
  • 请确保 commit 时已经还原安装程序造成的文件修改，主要是以下文件：
bash
.env-example
config/buildadmin.php
config/database.php
# 可能会有其他文件，请保证提交的文件仅新增功能或修复Bug产生的文件变更即可

# 还原单个文件的命令
git restore <文件名>
  • 提交时请参考 提交规范 。
  • 接下来，推送到自己的远程仓库。
bash
git push

4. 创建合并请求

进入您 Fork 的 BuildAdmin 仓库的页面，点击 Pull Request 创建合并请求，源分支选择自己仓库的 v2，目标分支选择 BuildAdmin 官方仓库的 v2，详细描述你的合并请求。

代码规范 ​

  1. 请参考 代码编辑器配置 文档完成编辑器的配置。
  2. web 端代码可以直接执行 pnpm format 命令和 pnpm lint 检查和格式化代码。
  3. server 端代码使用了 psr-12 代码规范，请参考以上 第1点 完成配置，然后使用 Ctrl+Alt+L 来格式化代码。
  4. 所有文件使用 LF 作为换行符。
  5. 所有文件必须且只可使用不带 BOM 的 UTF-8 编码。
  6. 类名必须以类似 StudlyCaps 形式的大写开头的驼峰命名方式声明。
  7. 方法和变量名称必须符合 camelCase 式的小写开头驼峰命名规范。