Skip to content

Commit

Permalink
代码格式调整:*.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wangliang181230 committed Nov 18, 2024
1 parent c3d614c commit 07ce75b
Show file tree
Hide file tree
Showing 13 changed files with 183 additions and 140 deletions.
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/1_BUG_REPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ labels: Bug
---

<!-- 如果搜索过但未找到,请将 `[ ]` 替换为 `[x]` -->

- [ ] 你是否在现有 [Issue列表](/docmirror/dev-sidecar/issues) 中搜索过相同问题,但未找到?

### Ⅰ. 请说明操作系统及DS的版本号:

1. 操作系统:?
2. DS版本号:? <!-- 如:`1.8.6-node17` -->

Expand All @@ -22,10 +24,15 @@ labels: Bug
3. xxx

### Ⅴ. 请提供相关的错误日志,尽可能的详细:(日志文件在 `${user.home}/.dev-sidecar/logs/` 目录下)

```log
```

### Ⅵ. 有必要时,请提供 `${user.home}/.dev-sidecar/running.json` 文件内容:

<!-- 请将 'running.json' 文件的内容粘贴在这里,方便我们排查问题是否由配置错误导致。 -->

```json

```
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/2_STYLE_ISSUE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ labels: Style Issue
---

<!-- 如果搜索过但未找到,请将 `[ ]` 替换为 `[x]` -->

- [ ] 你是否在现有 [Issue列表](/docmirror/dev-sidecar/issues) 中搜索过相同问题,但未找到?

### Ⅰ. 请说明操作系统及DS的版本号:

1. 操作系统:?
2. DS版本号:? <!-- 如:`1.8.6-node17` -->

Expand Down
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/3_CONFIG_ISSUES.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ labels: Config Issue
---

### Ⅰ. 你对哪个功能的配置不了解?

<!-- 请选择一个或多个选项,将前面的 `[ ]` 修改为 `[x]` 即可。 -->

- [ ] 拦截设置:
Expand All @@ -28,6 +29,9 @@ labels: Config Issue
### Ⅱ. 请详细描述你的问题:

### Ⅲ. 有必要时,请提供 `${user.home}/.dev-sidecar/running.json` 文件内容:

<!-- 请将 'running.json' 文件的内容粘贴在这里,方便我们排查问题是否由配置错误导致。 -->

```json

```
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATE/4_FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,13 @@ labels: Feature Request
---

### Ⅰ. 请描述你想要的新功能:

<!-- 请简单描述你希望的新功能,例如:"在某某页面,添加一个按钮,点击按钮时,弹出一个某某对话框,用于xxx。" -->

### Ⅱ. 请描述你心目中新功能的样子:

<!-- 可以讲讲你对新功能的看法,可以解释更多关于该功能的输入和输出的信息,或贴上你设想的界面设计。 -->

### Ⅲ. 你希望该新功能修复哪个issue?

<!-- 请将相关issue的编号填写在下面,格式如:#123 -->
4 changes: 3 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
### Ⅰ. 描述此PR的作用:

### Ⅱ. 此PR修复了哪个issue吗?
<!-- 如果是的话, 请在下一行写上 "fixes #xxx",比如:fixes #97 -->

<!-- 如果是的话,请在下一行写上 "fixes #xxx",比如:fixes #97 -->

### Ⅲ. 界面变化截屏

<!-- 如果存在界面上的变化,请截屏展示出来 -->
20 changes: 10 additions & 10 deletions .github/workflows/build-and-release.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: 'Build And Release'
name: Build And Release

on:
push:
Expand All @@ -21,7 +21,7 @@ jobs:
node:
- 22
steps:
- name: 'Checkout'
- name: Checkout
uses: actions/checkout@v4.1.7

- name: 'Setup Node.js "${{ matrix.node }}.x" environment'
Expand All @@ -30,22 +30,22 @@ jobs:
node-version: ${{ matrix.node }}
registry-url: https://npm.pkg.github.com/

- name: 'Setup pnpm'
- name: Setup pnpm
uses: pnpm/action-setup@v4

- name: 'Setup Python environment (Mac) Because of electron-builder install-app-deps requires Python setup tools'
- name: Setup Python environment (Mac) Because of electron-builder install-app-deps requires Python setup tools
if: matrix.os == 'macos'
uses: actions/setup-python@v5
with:
python-version: '3.10'

- name: 'Get package info'
- name: Get package info
id: package-info
uses: luizfelipelaviola/get-package-info@v1
with:
path: ./packages/mitmproxy

- name: 'Print'
- name: Print
run: |
echo "version = ${{ steps.package-info.outputs.version }}";
echo "github.ref_type = ${{ github.ref_type }}";
Expand All @@ -69,7 +69,7 @@ jobs:
echo "--------------------";
python --version;
- name: 'pnpm install'
- name: pnpm install
run: |
echo "======================================================================";
dir || ls -lah;
Expand Down Expand Up @@ -139,10 +139,10 @@ jobs:
needs:
- build-and-upload
steps:
- name: 'Checkout'
- name: Checkout
uses: actions/checkout@v4.1.7

- name: 'Get package info'
- name: Get package info
id: package-info
uses: luizfelipelaviola/get-package-info@v1
with:
Expand Down Expand Up @@ -177,7 +177,7 @@ jobs:
run: |
ls -lah release;
- name: 'Create a draft release'
- name: Create a draft release
uses: wangliang181230/github-action-ghr@master
env:
GITHUB_TOKEN: ${{ github.token }}
Expand Down
17 changes: 9 additions & 8 deletions .github/workflows/test-and-upload.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
name: 'Test And Upload'
name: Test And Upload

on:
push:
branches:
- master
- '1.x'
- 1.x
pull_request:
branches:
- master
- 1.x

jobs:
test-and-upload:
Expand All @@ -22,7 +23,7 @@ jobs:
node:
- 22
steps:
- name: 'Checkout'
- name: Checkout
uses: actions/checkout@v4.1.7

- name: 'Setup Node.js "${{ matrix.node }}.x" environment'
Expand All @@ -31,22 +32,22 @@ jobs:
node-version: ${{ matrix.node }}
registry-url: https://npm.pkg.github.com/

- name: 'Setup pnpm'
- name: Setup pnpm
uses: pnpm/action-setup@v4

- name: 'Setup Python environment (Mac) Because of electron-builder install-app-deps requires Python setup tools'
- name: Setup Python environment (Mac) Because of electron-builder install-app-deps requires Python setup tools
if: matrix.os == 'macos'
uses: actions/setup-python@v5
with:
python-version: '3.10'

- name: 'Get package info'
- name: Get package info
id: package-info
uses: luizfelipelaviola/get-package-info@v1
with:
path: ./packages/mitmproxy

- name: 'Print'
- name: Print
run: |
echo "version = ${{ steps.package-info.outputs.version }}";
echo "github.ref_type = ${{ github.ref_type }}";
Expand All @@ -70,7 +71,7 @@ jobs:
echo "--------------------";
python --version;
- name: 'pnpm install'
- name: pnpm install
run: |
echo "======================================================================";
dir || ls -lah;
Expand Down
Loading

0 comments on commit 07ce75b

Please sign in to comment.