Skip to content

Commit 48e92f7

Browse files
committed
docs: add bilingual project documentation
1 parent 42ca96b commit 48e92f7

8 files changed

Lines changed: 525 additions & 173 deletions

File tree

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,69 @@
11
name: Bug Report
2-
description: 报告可复现的显示、窗口选择、输入或兼容性问题
2+
description: Report a reproducible display, window selection, input, or compatibility issue
33
title: "[Bug] "
44
labels: [bug]
55
body:
66
- type: checkboxes
77
attributes:
8-
label: 提交前检查
8+
label: Pre-flight checks
99
options:
10-
- label: 我已搜索现有 Issue,没有找到相同问题。
10+
- label: I have searched existing issues and did not find the same problem.
1111
required: true
12-
- label: 我已保存目标应用中的重要工作,并了解项目使用私有 macOS API。
12+
- label: I have saved important work in the target app and understand that this project uses private macOS APIs.
1313
required: true
1414

1515
- type: input
1616
attributes:
17-
label: Mac 型号与芯片
18-
placeholder: 例如 MacBook Pro 14-inch, M4 Pro
17+
label: Mac model and chip
18+
placeholder: "Example: MacBook Pro 14-inch, M4 Pro"
1919
validations:
2020
required: true
2121

2222
- type: input
2323
attributes:
24-
label: macOS 版本
25-
placeholder: 例如 macOS 26.5.1
24+
label: macOS version
25+
placeholder: "Example: macOS 26.5.1"
2626
validations:
2727
required: true
2828

2929
- type: input
3030
attributes:
31-
label: 目标应用
32-
placeholder: 应用名称与版本
31+
label: Target app
32+
placeholder: App name and version
3333
validations:
3434
required: true
3535

3636
- type: dropdown
3737
attributes:
38-
label: 辅助功能权限
38+
label: Accessibility permission
3939
options:
40-
- 已授权
41-
- 未授权
42-
- 不确定
40+
- Granted
41+
- Not granted
42+
- Unsure
4343
validations:
4444
required: true
4545

4646
- type: textarea
4747
attributes:
48-
label: 复现步骤
49-
placeholder: 请按顺序描述从启动程序到问题出现的操作。
48+
label: Reproduction steps
49+
placeholder: Describe the exact steps from launching MacNotchKiller to seeing the issue.
5050
validations:
5151
required: true
5252

5353
- type: textarea
5454
attributes:
55-
label: 预期行为
55+
label: Expected behavior
5656
validations:
5757
required: true
5858

5959
- type: textarea
6060
attributes:
61-
label: 实际行为与完整错误文本
61+
label: Actual behavior and complete error text
6262
validations:
6363
required: true
6464

6565
- type: textarea
6666
attributes:
67-
label: 显示器环境与补充日志
68-
description: 请说明外接显示器数量、排列方式,并粘贴终端日志。
67+
label: Display setup and additional logs
68+
description: Include the number of external displays, their arrangement, and terminal logs.
6969
render: shell
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: 问题报告(中文)
2+
description: 报告可复现的显示、窗口选择、输入或兼容性问题
3+
title: "[Bug] "
4+
labels: [bug]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: 提交前检查
9+
options:
10+
- label: 我已搜索现有 Issue,没有找到相同问题。
11+
required: true
12+
- label: 我已保存目标应用中的重要工作,并了解项目使用私有 macOS API。
13+
required: true
14+
15+
- type: input
16+
attributes:
17+
label: Mac 型号与芯片
18+
placeholder: "例如 MacBook Pro 14-inch, M4 Pro"
19+
validations:
20+
required: true
21+
22+
- type: input
23+
attributes:
24+
label: macOS 版本
25+
placeholder: "例如 macOS 26.5.1"
26+
validations:
27+
required: true
28+
29+
- type: input
30+
attributes:
31+
label: 目标应用
32+
placeholder: 应用名称与版本
33+
validations:
34+
required: true
35+
36+
- type: dropdown
37+
attributes:
38+
label: 辅助功能权限
39+
options:
40+
- 已授权
41+
- 未授权
42+
- 不确定
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
attributes:
48+
label: 复现步骤
49+
placeholder: 请按顺序描述从启动 MacNotchKiller 到问题出现的操作。
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
attributes:
55+
label: 预期行为
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
attributes:
61+
label: 实际行为与完整错误文本
62+
validations:
63+
required: true
64+
65+
- type: textarea
66+
attributes:
67+
label: 显示器环境与补充日志
68+
description: 请说明外接显示器数量、排列方式,并粘贴终端日志。
69+
render: shell

CONTRIBUTING.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,54 @@
1-
# 贡献指南
1+
# Contributing
22

3-
感谢你改进 MacNotchKiller。这个项目依赖 macOS 私有显示接口,提交问题或代码时,请尽量提供可复现、可验证的信息。
3+
Thanks for improving MacNotchKiller. This project depends on private macOS display APIs, so issues and patches should be reproducible and grounded in real behavior.
44

5-
## 开发环境
5+
[简体中文](CONTRIBUTING.zh-CN.md)
66

7-
- macOS 13 或更高版本
7+
## Development environment
8+
9+
- macOS 13 or later
810
- Apple Silicon Mac
9-
- Swift 5.10 或更高版本工具链
11+
- Swift 5.10 or later
1012

1113
```bash
1214
git clone https://github.com/DTW7607/MacNotchKiller.git
1315
cd MacNotchKiller
1416
swift build
1517
```
1618

17-
## 提交问题
19+
## Reporting issues
1820

19-
请使用仓库的 Bug Report 模板,并至少提供:
21+
Use the repository's Bug Report template. Include at least:
2022

21-
- Mac 型号和芯片
22-
- macOS 完整版本号
23-
- 目标应用及其版本
24-
- 是否已授予辅助功能权限
25-
- 可稳定复现的操作步骤
26-
- 完整错误文本或终端日志
23+
- Mac model and chip
24+
- Full macOS version
25+
- Target app and version
26+
- Whether Accessibility permission has been granted
27+
- Stable reproduction steps
28+
- Complete error text or terminal logs
2729

28-
显示器排列和输入问题请同时说明外接显示器数量及排列方式。
30+
For display arrangement or input issues, also include the number of external displays and how they are arranged.
2931

30-
## 提交代码
32+
## Submitting code
3133

32-
1. `main` 创建短期功能分支。
33-
2. 保持改动范围集中,不混入构建缓存或本机配置。
34-
3. 对生命周期、坐标系、Event Tap 和异步回调的改动补充必要注释。
35-
4. 执行 `swift build` `swift build -c release`
36-
5. 在 Pull Request 中说明验证环境、预期行为和已知风险。
34+
1. Create a short-lived feature branch from `main`.
35+
2. Keep the change focused, and do not include build caches or local configuration.
36+
3. Add comments where lifecycle, coordinate systems, Event Tap behavior, or async callbacks are non-obvious.
37+
4. Run `swift build` and `swift build -c release`.
38+
5. In the pull request, describe the validation environment, expected behavior, and known risks.
3739

38-
建议使用 Conventional Commits
40+
Use Conventional Commits when practical:
3941

4042
```text
4143
feat(selection): add interactive window highlighting
4244
fix(display): wait for virtual display registration before positioning
4345
docs: document permissions and recovery shortcut
4446
```
4547

46-
## 工程约束
48+
## Engineering constraints
4749

48-
- 不提交 `.build/` 或其他生成物。
49-
- 不直接链接私有类符号;私有 API 必须继续通过窄桥接层和运行时检测访问。
50-
- 不削弱 `Control + Option + Command + Q` 故障退出路径。
51-
- 不把真实设备上的成功结果等同于其他 macOS 版本兼容。
52-
- 不添加遥测、网络请求或画面上传行为,除非经过单独讨论并默认关闭。
50+
- Do not commit `.build/` or other generated files.
51+
- Do not directly link private class symbols. Private API access must remain behind the narrow bridge layer and runtime checks.
52+
- Do not weaken the `Control + Option + Command + Q` recovery path.
53+
- Do not treat success on one real device as proof of compatibility across macOS versions.
54+
- Do not add telemetry, network requests, or screen upload behavior unless discussed separately and disabled by default.

CONTRIBUTING.zh-CN.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# 贡献指南
2+
3+
感谢你改进 MacNotchKiller。这个项目依赖 macOS 私有显示接口,提交问题或代码时,请尽量提供可复现、可验证的信息。
4+
5+
[English](CONTRIBUTING.md) | 简体中文
6+
7+
## 开发环境
8+
9+
- macOS 13 或更高版本
10+
- Apple Silicon Mac
11+
- Swift 5.10 或更高版本工具链
12+
13+
```bash
14+
git clone https://github.com/DTW7607/MacNotchKiller.git
15+
cd MacNotchKiller
16+
swift build
17+
```
18+
19+
## 提交问题
20+
21+
请使用仓库的 Bug Report 模板,并至少提供:
22+
23+
- Mac 型号和芯片
24+
- macOS 完整版本号
25+
- 目标应用及其版本
26+
- 是否已授予辅助功能权限
27+
- 可稳定复现的操作步骤
28+
- 完整错误文本或终端日志
29+
30+
显示器排列和输入问题请同时说明外接显示器数量及排列方式。
31+
32+
## 提交代码
33+
34+
1.`main` 创建短期功能分支。
35+
2. 保持改动范围集中,不混入构建缓存或本机配置。
36+
3. 对生命周期、坐标系、Event Tap 和异步回调的改动补充必要注释。
37+
4. 执行 `swift build``swift build -c release`
38+
5. 在 Pull Request 中说明验证环境、预期行为和已知风险。
39+
40+
建议使用 Conventional Commits:
41+
42+
```text
43+
feat(selection): add interactive window highlighting
44+
fix(display): wait for virtual display registration before positioning
45+
docs: document permissions and recovery shortcut
46+
```
47+
48+
## 工程约束
49+
50+
- 不提交 `.build/` 或其他生成物。
51+
- 不直接链接私有类符号;私有 API 必须继续通过窄桥接层和运行时检测访问。
52+
- 不削弱 `Control + Option + Command + Q` 故障退出路径。
53+
- 不把真实设备上的成功结果等同于其他 macOS 版本兼容。
54+
- 不添加遥测、网络请求或画面上传行为,除非经过单独讨论并默认关闭。

0 commit comments

Comments
 (0)