Skip to content

贡献指南

Jump to bottom
liukun edited this page May 21, 2025 · 5 revisions

1. Fork仓库

  • 在GitHub上找到目标仓库，点击右上角的"Fork"按钮，将仓库复制到你的GitHub账户下

2. 克隆仓库到本地

3. 创建新分支

  • 为你的修改创建一个新分支，避免直接在主分支上操作：
  • git checkout -b 你的分支名称

4. 修改代码

  • 在本地仓库中进行代码修改。确保遵循项目的代码风格和规范，避免格式化问题。
  • 若有新增国际化词条，则需删除template/nestJs/dist文件夹，并修改template/nestJs/libs/db/src/db.service.ts 中的dropSchema属性为true，删除原有表结构，重新初始化
本地tiny-pro目录如下
  -template
    -nestJs    # 后端服务
    -tinyvue   # 前端服务


## 后端启动

后端服务支持 `Docker 启动` 与 `命令启动` 两种方式。

### Docker 启动

请确保您安装了 `Docker`。

在 `tiny-pro/template/nestJs` 下执行以下命令，启动后端服务：

```bash
docker compose up -d


### 命令启动

请确保您安装了 `MySQL`、`Redis`。

在启动项目前请您做好如下检查：

- MySQL 服务可以正常访问
- Redis 服务可以正常访问
- 在tiny-pro/template/nestJs目录下添加.env文件，文件内容如下
  - DATABASE_HOS = 'localhost'
  - DATABASE_PORT = 3306
  - DATABASE_USERNAME = 'root'
  - DATABASE_PASSWORD = 'root'
  - DATABASE NAME = 'ospp_nest'
  - DATABASE_SYNCHRONIZE = 'true'
  - DATABASE_AUTOLOADENTITIES = 'true'
  - AUTH_SECRET = 'secret'
  - REDIS_SECONDS = 7200 
  - REDIS_HOST = 'localhost'
  - REDIS_PORT = 6379
  - EXPIRES_IN = '2h'
  - PAGINATION_PAGE = 1
  - PAGINATION_LIMIT = 10 
- MySQL 中存在 `.env` 文件中 `DATABASE_NAME` 字段定义的数据库，且该数据库为空
- `.env` 文件中 `DATABASE_SYNCHRONIZE` 为 `true`


完成上述检查后，您可以在 `tiny-pro/template/nestJs` 下执行以下命令，启动后端服务：

```bash
npm i && npm start

## 前端启动

在 `tiny-pro/template/tinyvue` 下依次执行以下命令：

- 安装依赖：`npm i`
- 启动前端项目：`npm start`

5. 提交修改

  • 添加修改的文件到暂存区：
  • git add .
  • 提交修改，编写清晰的提交信息：
  • git commit -m "你的提交信息"

6. Push修改到Fork仓库

  • 将本地分支推送到你的Fork仓库：
  • git push origin 你的分支名称

7. 创建Pull Request (PR)

  • 在GitHub上，进入你的Fork仓库页面。
  • 点击"Compare & pull request"按钮，选择目标仓库的主分支dev。
  • 填写PR的标题和描述，说明你的修改内容和目的。
  • 提交PR，等待维护者审核。

8. 处理Issue

  • 如果你发现项目中的问题，可以在GitHub上创建Issue，描述问题并提供复现步骤
  • 如果你有解决方案，可以在Issue中提出建议，或直接通过PR修复问题。

Clone this wiki locally