Skip to content

Commit e44ff27

Browse files
committed
docs: finalize open-source readiness baseline
1 parent fef7a11 commit e44ff27

12 files changed

Lines changed: 188 additions & 64 deletions

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: Security report
4-
url: https://github.com/chocoHunter/matcha/security
4+
url: https://github.com/chocoHunter/matcha/security/advisories/new
55
about: Please use private security reporting for vulnerabilities or sensitive power-management issues.

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ Build/
55
*.xcworkspace/
66
*.xcodeproj
77
*.xcworkspace
8-
Matcha.entitlements
98
Sources/Matcha
109
*.app/
1110
*.dmg

CHANGELOG.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,19 @@ All notable changes to this project will be documented in this file.
44

55
## Unreleased
66

7-
- Added battery-mode recovery using stored `pmset` snapshots instead of fixed restore values.
8-
- Added startup self-healing and clearer recovery behavior for battery-mode power overrides.
9-
- Added lid-close display sleep handling for battery mode to better match closed-lid background use.
10-
- Added unit tests for `pmset` parsing, restore planning, and lid-close display-sleep transitions.
11-
- Added a release build script for generating and validating `.app` and `.dmg` artifacts.
12-
- Added CI, open-source readiness docs, and repository metadata files.
13-
- Improved README and README-CN with clearer mode explanations, recovery guidance, and build steps.
7+
- Added open-source community files: `CONTRIBUTING.md`, `SECURITY.md`, issue templates, and PR template.
8+
- Improved `README.md` and `README-CN.md` structure with clearer mode differences and onboarding screenshots.
9+
- Added release documentation for signing, notarization, and verification workflow.
10+
- Improved battery-mode safety behavior and recovery documentation.
1411

15-
## 1.0.0
12+
## 1.0.1 - 2026-03-08
13+
14+
- Added **Lid Closed (Battery)** mode for closed-lid operation without power adapter.
15+
- Improved menu UI with mutually exclusive mode checkmarks.
16+
- Moved **Resume Sleep** to the top as the default state.
17+
- Updated app icon.
18+
- Fixed password prompt behavior so admin auth is only requested when enabling battery mode.
19+
20+
## 1.0.0 - 2026-02-28
1621

1722
- Initial public project structure and menu bar sleep-prevention modes.

CODE_OF_CONDUCT.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as contributors and maintainers pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment include:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologizing to those affected by our mistakes
17+
- Focusing on what is best for the community and project users
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
- Trolling, insulting or derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or email address, without explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all project spaces and also applies when an individual is officially representing the project in public spaces.
36+
37+
## Reporting and Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported via:
40+
41+
- Private vulnerability reporting: https://github.com/chocoHunter/matcha/security/advisories/new
42+
43+
All reports will be reviewed and investigated promptly and fairly.
44+
45+
## Enforcement Guidelines
46+
47+
Maintainers will follow these Community Impact Guidelines in determining consequences for any action deemed in violation of this Code of Conduct:
48+
49+
1. Correction: Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome.
50+
Consequence: A private, written warning from maintainers, with clarity around the nature of the violation and an explanation of why the behavior was inappropriate.
51+
52+
2. Warning: Community Impact: A violation through a single incident or series of actions.
53+
Consequence: A warning with consequences for continued behavior. No interaction with the people involved for a specified period of time.
54+
55+
3. Temporary Ban: Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
56+
Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period.
57+
58+
4. Permanent Ban: Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
59+
Consequence: A permanent ban from any sort of public interaction within the project.
60+
61+
## Attribution
62+
63+
This Code of Conduct is adapted from the Contributor Covenant, version 2.1:
64+
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

README-CN.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,19 @@
1111
- 定时模式:15 分钟到 24 小时,或永久
1212
- 开机自启
1313

14+
## 安装方式
15+
16+
### 方式一:下载发布包(推荐)
17+
18+
1. 打开 [Releases](https://github.com/chocoHunter/matcha/releases)
19+
2. 下载最新 `Matcha.dmg`
20+
3.`Matcha.app` 拖到 `/Applications`
21+
4. 首次启动时按提示授权。
22+
23+
### 方式二:本地源码构建
24+
25+
可直接使用文末 `如何构建` 章节。
26+
1427
## 使用方法
1528

1629
1. 点击菜单栏 Matcha 图标。
@@ -80,6 +93,7 @@ sudo pmset restoredefaults
8093
## 项目文档
8194

8295
- `CONTRIBUTING.md`:贡献流程与测试要求
96+
- `CODE_OF_CONDUCT.md`:社区协作行为准则
8397
- `SECURITY.md`:安全漏洞反馈方式
8498
- `CHANGELOG.md`:项目重要变更记录
8599
- `docs/release.md`:发布检查、签名与公证流程

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,19 @@ A macOS menu bar app for preventing sleep, with practical lid-closed modes for M
1111
- Flexible timer (15 min to 24 hours, or permanent)
1212
- Launch at login
1313

14+
## Install
15+
16+
### Option 1: Download release (recommended)
17+
18+
1. Open [Releases](https://github.com/chocoHunter/matcha/releases).
19+
2. Download the latest `Matcha.dmg`.
20+
3. Drag `Matcha.app` into `/Applications`.
21+
4. Launch Matcha and grant permissions when prompted.
22+
23+
### Option 2: Build from source
24+
25+
Use the build steps in `How to Build` below.
26+
1427
## Usage
1528

1629
1. Click the Matcha menu bar icon.
@@ -80,6 +93,7 @@ sudo pmset restoredefaults
8093
## Project Docs
8194

8295
- `CONTRIBUTING.md`: contributor workflow and testing expectations
96+
- `CODE_OF_CONDUCT.md`: community standards and enforcement rules
8397
- `SECURITY.md`: vulnerability reporting guidance
8498
- `CHANGELOG.md`: notable project changes
8599
- `docs/release.md`: release checklist, signing, and notarization workflow

SECURITY.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@ Matcha is currently maintained on the latest `main` branch.
88

99
Please do not open a public GitHub issue for security-sensitive reports.
1010

11-
Instead, report vulnerabilities privately to the maintainer through GitHub security reporting if available, or by direct maintainer contact before public disclosure.
11+
Please report vulnerabilities through GitHub Private Vulnerability Reporting:
12+
13+
- https://github.com/chocoHunter/matcha/security/advisories/new
14+
15+
If that page is unavailable for any reason, open an issue titled `SECURITY: private contact request` without technical details, and we will move to a private channel.
1216

1317
When reporting, please include:
1418

Sources/Info.plist

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717
<key>CFBundlePackageType</key>
1818
<string>APPL</string>
1919
<key>CFBundleShortVersionString</key>
20-
<string>1.0.0</string>
20+
<string>$(MARKETING_VERSION)</string>
2121
<key>CFBundleVersion</key>
22-
<string>1</string>
22+
<string>$(CURRENT_PROJECT_VERSION)</string>
2323
<key>LSMinimumSystemVersion</key>
2424
<string>$(MACOSX_DEPLOYMENT_TARGET)</string>
2525
<key>LSUIElement</key>

Sources/Matcha.entitlements

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
3+
<plist version="1.0">
4+
<dict/>
5+
</plist>

docs/2026-03-14-open-source-readiness-todo.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
- [x] 明确危险能力说明:在 README/README-CN 加入“会修改系统电源策略(pmset)”的风险提示和恢复说明
1010
- [x] 清理发布流程中的本地产物策略:确认 `Build/``*.dmg``Matcha.xcodeproj` 是否应提交;若不提交,完善 `.gitignore`(当前仅忽略 `build/`,未覆盖 `Build/`
1111
- [x] 增加最小可验证构建说明(本机若未安装完整 Xcode,会导致 `xcodebuild` 不可用)
12+
- [x] 对齐版本与发布记录(`project.yml``Info.plist``CHANGELOG.md`
13+
- [ ] 仓库切换为 Public,并补充仓库描述与 Topics
14+
- [ ] 完成 Developer ID 签名、公证、staple 与 `spctl` 校验后再发布二进制
1215

1316
## P1 - 建议在首次开源后尽快补齐
1417

@@ -18,6 +21,7 @@
1821
- [x] 增加 `SECURITY.md`(漏洞报告渠道、处理 SLA)
1922
- [x] 增加 Issue / PR Template,减少社区沟通成本
2023
- [x] 增加发布文档:签名、公证、DMG 产物生成与校验步骤
24+
- [x] 增加 `CODE_OF_CONDUCT.md`,补齐社区协作规范
2125

2226
## P2 - 体验与可维护性优化
2327

0 commit comments

Comments
 (0)