diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..07a59ead --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,11 @@ +# 行为准则 + +参与 OmarchyCN 社区(issue、PR、讨论)时: + +- 尊重他人,就事论事,不进行人身攻击、骚扰或歧视 +- 欢迎新手提问,回答保持耐心 +- 技术分歧用证据和代码说话 +- 不发布垃圾信息、广告或与项目无关的内容 + +违反者由维护者视情节警告、删除内容或封禁账号。 +举报渠道见 [SECURITY.md](SECURITY.md) 中的联系方式。 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..09cd6da2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# 贡献指南 + +## 仓库结构 + +- 上游 Omarchy 代码尽量不动;OmarchyCN 改动集中在 `bin/omarchy-cn-*`、`bin/omarchycn`、`cn/`、`install/cn/` +- 上游同步由 `.gitea/workflows/upstream-sync.yml` 自动开同步 PR,人工审查合并 + +## 提交规范 + +- 遵循 [AGENTS.md](AGENTS.md) 的全部代码与命令约定(Bash 5、`[[ ]]`/`(( ))`、两空格缩进、`#!/bin/bash`) +- 提交保持原子:一个提交只做一件事 +- 涉及系统修改的命令必须支持 `--dry-run`,写配置前先备份 + +## 测试 + +- CLI 与 shell 改动跑 `./test/all` +- OmarchyCN 新增测试放在 `test/shell.d/*-test.sh` + +## 提交流程 + +1. Fork 或在 issue 中讨论 +2. 提交 PR 到 `quattro` 分支,说明动机与验证方式 +3. 通过 CI 与代码审查后合并 diff --git a/NOTICE b/NOTICE new file mode 100644 index 00000000..81cde6b0 --- /dev/null +++ b/NOTICE @@ -0,0 +1,14 @@ +OmarchyCN + +Copyright (c) 2026 Zachary Zhang / OmarchyCN Community + +本发行版基于 Omarchy(https://github.com/basecamp/omarchy), +Copyright (c) 2025 David Heinemeier Hansson,MIT License。 +上游文件保留其原始版权与许可证声明(见 LICENSE)。 + +OmarchyCN 原创代码(bin/omarchy-cn-*、cn/、install/cn/ 及相关文档) +采用 MIT License 发布。 + +OmarchyCN is an independent community distribution based on Omarchy. +OmarchyCN is not affiliated with or endorsed by Basecamp, 37signals, +or the Omarchy maintainers. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..59f3b6f8 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,19 @@ +# 安全政策 + +## 报告漏洞 + +请勿在公开 issue 中披露安全漏洞。发送邮件至: + +**zhangyanghaha0407@outlook.com**(主题注明 [OmarchyCN Security]) + +请附:影响版本、复现步骤、影响面评估。我们在 72 小时内确认,修复后在 +Release Notes 中致谢(除非你要求匿名)。 + +## 范围 + +- OmarchyCN 软件包、ISO、安装与更新脚本、Registry 与签名链路 +- 上游 Omarchy / Arch / Hyprland 的漏洞请报给对应上游项目 + +## 签名验证 + +Release 产物的 PGP 公钥与验证方法见 [docs/release-signing.md](docs/release-signing.md)。