Skip to content

AI turns documents or topics into real, native PowerPoint decks—with native shapes, transitions and animations, data-backed charts and tables on demand, audio narration from speaker notes, and support for your own .pptx templates. · by Hugo He

docs: add CONTRIBUTING and SECURITY, simplify README contributing section

hugohe3c65b341714e3
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..1a12993c
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,62 @@
+# Contributing to PPT Master
+
+Thank you for your interest in contributing! This guide will help you get started.
+
+## Ways to Contribute
+
+- **Templates** — New layout templates or visual styles
+- **Charts** — Additional chart types or SVG chart templates
+- **Icons** — Vector icons for the icon library
+- **Scripts** — Improvements to conversion or post-processing scripts
+- **Docs** — Clarifications, translations, or new guides
+- **Bug reports** — Reproducible issues with clear descriptions
+- **Ideas** — Feature requests and design suggestions
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.8+
+- Node.js 18+ (optional, for WeChat page conversion)
+- Pandoc (optional, for DOCX/EPUB conversion)
+
+### Setup
+
+```bash
+git clone https://github.com/hugohe3/ppt-master.git
+cd ppt-master
+pip install -r requirements.txt
+```
+
+## Contribution Workflow
+
+1. **Fork** the repository and create a branch from `main`
+2. **Make your changes** — keep commits focused and descriptive
+3. **Test** your changes locally before submitting
+4. **Open a Pull Request** with a clear description of what you changed and why
+
+## SVG Guidelines
+
+If your contribution involves SVG files, follow the technical constraints documented in [CLAUDE.md](./CLAUDE.md):
+
+- Do not use: `clipPath`, `mask`, `<style>`, `class`, external CSS, `<foreignObject>`, `<animate*>`, `<script>`, `marker-end`, `<symbol>+<use>`
+- Use `fill-opacity` / `stroke-opacity` instead of `rgba()`
+- Use `<polygon>` triangles instead of `marker-end` arrows
+- All SVGs must use the correct `viewBox` for the target canvas format
+
+## Reporting Bugs
+
+Open an issue on [GitHub Issues](https://github.com/hugohe3/ppt-master/issues) and include:
+
+- A clear description of the problem
+- Steps to reproduce
+- Expected vs. actual behavior
+- Environment details (OS, Python version, AI editor used)
+
+## Code of Conduct
+
+Please read and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the [MIT License](./LICENSE).
diff --git a/README.md b/README.md
index c3358e8d..d6d8ec2d 100644
--- a/README.md
+++ b/README.md
@@ -117,9 +117,7 @@ Run `python3 skills/ppt-master/scripts/image_gen.py --list-backends` to see tier
## Contributing
-1. Fork → branch → commit → PR
-
-**Areas:** 🎨 Templates · 📊 Charts · 📝 Docs · 🐛 Bugs · 💡 Ideas
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for how to get involved.
## License
diff --git a/README_CN.md b/README_CN.md
index e6742d05..f9773e5a 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -117,9 +117,7 @@ GEMINI_MODEL=gemini-3.1-flash-image-preview
## 贡献
-1. Fork → 分支 → 提交 → PR
-
-**方向:** 🎨 模板 · 📊 图表 · 📝 文档 · 🐛 Bug · 💡 建议
+详见 [CONTRIBUTING.md](./CONTRIBUTING.md)。
## 开源协议
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 00000000..a7113743
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,45 @@
+# Security Policy
+
+## Supported Versions
+
+We provide security updates for the latest version of PPT Master.
+
+| Version | Supported |
+|---------|-----------|
+| Latest | Yes |
+| Older | No |
+
+## Reporting a Vulnerability
+
+**Please do not report security vulnerabilities through public GitHub Issues.**
+
+If you discover a security issue, please report it privately by emailing:
+
+
+Include in your report:
+
+- A description of the vulnerability
+- Steps to reproduce the issue
+- The potential impact
+- Any suggested fix, if you have one
+
+We will acknowledge your report within **72 hours** and aim to provide a resolution timeline within **7 days**.
+
+## Scope
+
+This policy covers the PPT Master source code in this repository, including:
+
+- Python scripts in `skills/ppt-master/scripts/`
+- Post-processing pipeline (`total_md_split.py`, `finalize_svg.py`, `svg_to_pptx.py`)
+- Project management utilities
+
+Out of scope:
+
+- Third-party AI editors or APIs (Claude, Cursor, GitHub Copilot, etc.)
+- Generated PPTX output files
+- User-provided source documents
+
+## Disclosure Policy
+
+We follow responsible disclosure. Once a fix is available, we will publish a GitHub Security Advisory crediting the reporter (unless they prefer to remain anonymous).