diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7af0ba6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing to Proma + +感谢你对 Proma 的贡献兴趣!以下是参与贡献的指南。 + +## 开发环境 + +### 前置要求 + +- Node.js 18+ +- pnpm 或 npm + +### 快速开始 + +```bash +# 克隆仓库 +git clone https://github.com/ErlichLiu/Proma.git +cd Proma + +# 安装依赖 +pnpm install + +# 启动开发模式 +pnpm dev +``` + +## 提交变更 + +1. **Fork** 本仓库 +2. 从 `main` **创建分支**: `git checkout -b fix/my-fix` +3. **修改代码**并本地测试 +4. **提交**时使用清晰的 commit message +5. **推送**并创建 Pull Request + +## 报告问题 + +- 使用 GitHub Issues 报告 bug 或提出功能请求 +- 请包含操作系统版本、应用版本和复现步骤 + +## 许可 + +贡献即表示同意按项目现有许可证授权你的贡献。 diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..a3d0829 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,23 @@ +# Security Policy + +## Reporting a Vulnerability + +If you discover a security vulnerability, please report it privately via GitHub Security Advisories or email the maintainers directly. + +Please include: +- Clear description +- Steps to reproduce +- Potential impact +- Suggested fix (if available) + +## Response Timeline + +- Acknowledgment: within 48 hours +- Updates: regular progress reports + +## Supported Versions + +| Version | Supported | +|---------|-----------| +| Latest | ✓ | +| Older | ✗ | \ No newline at end of file