Skip to content

Commit

Permalink
docs: 更新贡献说明
Browse files Browse the repository at this point in the history
  • Loading branch information
iDerekLi committed Aug 9, 2022
1 parent d070485 commit 5e0d83b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 33 deletions.
7 changes: 2 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
<!--
## 处理自动化相关逻辑
base: `workflows` <- compare `your branch`
## 处理JueJinAPI相关逻辑
base: `package` <- compare `your branch`
## 所有贡献请先合并至开发分支dev。
base: `dev` <- compare `your branch`
-->
37 changes: 9 additions & 28 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,22 @@
# 参与贡献

## 分支介绍

- `package` 掘金API发布npm包,供给自动化工作流使用。
- `workflows` 自动化工作流开发分支。
- `main` 是 workflows 分支的稳定版。

**处理自动化相关逻辑:**
base: `workflows` <- compare `your branch`

**处理JueJinAPI相关逻辑:**
base: `package` <- compare `your branch`

## workflows 分支

### 安装
## 项目结构
- packages 掘金API工程
- workflows 掘金自动化工作流项目

### 本地运行
- node >= 14.17.0
- `yarn` 安装依赖
- `yarn dev` 启动开发模式

### 环境变量

- `/scripts/utils/env.js` 替换本地测试所需的环境变量

### 本地运行工作流项目
- `cd workflows`
- `/utils/env.js` 替换本地测试所需的环境变量
```javascript
module.exports = {
COOKIE: "测试掘金Cookie",
// ...
};
```

### 本地运行

- `yarn checkin` 运行掘金签到脚本
- `yarn seagold` 运行海底掘金游戏脚本

## package 分支

- `yarn` 安装依赖
- `yarn dev` 启动开发模式
- `node tests/your-test.js` 测试一个模块

0 comments on commit 5e0d83b

Please sign in to comment.