From fe70eb14236f0738f23e80ddb462414ade5ed6af Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 17 Jun 2026 23:21:32 +0800 Subject: [PATCH] chore: optimize project metadata and CI/CD --- .github/ISSUE_TEMPLATE/bug_report.md | 51 +++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 14 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 52 +++++++++++++ .github/ISSUE_TEMPLATE/template_request.md | 56 ++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 85 ++++++++++++++++++++++ .github/workflows/ci.yml | 43 +++++++++++ CHANGELOG.md | 38 ++++++++++ LICENSE | 2 +- 8 files changed, 340 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/template_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/ci.yml create mode 100644 CHANGELOG.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..c12be35 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,51 @@ +--- +name: Bug Report +about: Create a report to help us improve +title: '[BUG] ' +labels: bug +assignees: '' + +--- + +## Bug Description +A clear and concise description of what the bug is. + +## Environment +- **OS**: [e.g., macOS 13.0, Ubuntu 22.04, Windows 11] +- **Python Version**: [e.g., 3.8, 3.9, 3.10] +- **PPTskill Version**: [e.g., commit hash or release tag] +- **Installation Method**: [pip, manual clone] + +## Steps to Reproduce +1. Go to '...' +2. Run command '...' +3. See error + +## Expected Behavior +A clear and concise description of what you expected to happen. + +## Actual Behavior +What actually happened. + +## Error Messages +``` +Paste any error messages or logs here +``` + +## Screenshots +If applicable, add screenshots to help explain your problem. + +## Sample Files +If relevant, attach or link to: +- Input files (PDF, DOCX, Markdown) +- Generated PPTX output +- Project configuration + +## Additional Context +Add any other context about the problem here. + +## Checklist +- [ ] I have searched existing issues to avoid duplicates +- [ ] I have checked the [FAQ](docs/faq.md) +- [ ] I have read the [README](README.md) +- [ ] I can reproduce this bug consistently diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..39fc8aa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Question or Discussion + url: https://github.com/AIPMAndy/PPTskill/discussions + about: Ask questions or discuss ideas with the community + - name: Documentation + url: https://github.com/AIPMAndy/PPTskill/blob/main/README.md + about: Read the comprehensive documentation + - name: FAQ + url: https://github.com/AIPMAndy/PPTskill/blob/main/docs/faq.md + about: Check frequently asked questions + - name: Upstream Project + url: https://github.com/hugohe3/ppt-master + about: Visit the original ppt-master project diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..03e279d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,52 @@ +--- +name: Feature Request +about: Suggest an idea for this project +title: '[FEATURE] ' +labels: enhancement +assignees: '' + +--- + +## Feature Description +A clear and concise description of the feature you'd like to see. + +## Problem Statement +What problem does this feature solve? Is your feature request related to a problem? +Example: "I'm always frustrated when..." + +## Proposed Solution +Describe the solution you'd like to see implemented. + +## Alternative Solutions +Describe any alternative solutions or features you've considered. + +## Use Case +Describe your specific use case for this feature: +- Who would benefit from this? +- How often would you use it? +- What value does it provide? + +## Examples +If applicable, provide examples of: +- Similar features in other tools +- Mock-ups or designs +- Sample workflows + +## Implementation Ideas +If you have technical suggestions for implementation, share them here. + +## Additional Context +Add any other context, screenshots, or references about the feature request here. + +## Priority +How important is this feature to you? +- [ ] Critical (blocking my work) +- [ ] High (would significantly improve my workflow) +- [ ] Medium (nice to have) +- [ ] Low (minor improvement) + +## Checklist +- [ ] I have searched existing issues to avoid duplicates +- [ ] I have checked the [Roadmap](README.md#-roadmap) +- [ ] This aligns with the project's design philosophy +- [ ] I am willing to contribute to implementation diff --git a/.github/ISSUE_TEMPLATE/template_request.md b/.github/ISSUE_TEMPLATE/template_request.md new file mode 100644 index 0000000..d099631 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/template_request.md @@ -0,0 +1,56 @@ +--- +name: Template Request +about: Request a new PPT template style +title: '[TEMPLATE] ' +labels: template, enhancement +assignees: '' + +--- + +## Template Style +What style are you requesting? (e.g., Minimalist, Corporate, Creative, Technical) + +## Visual References +Please provide visual references or examples: +- Links to similar presentations +- Screenshots of desired style +- Color schemes +- Typography preferences + +## Use Case +What would you use this template for? +- [ ] Business presentation +- [ ] Academic defense +- [ ] Product launch +- [ ] Training materials +- [ ] Marketing pitch +- [ ] Other: _______ + +## Key Requirements +What are the must-have elements? +- Layout preferences (e.g., title slide, content slides, closing) +- Color palette +- Typography style +- Icon/graphic style +- Special elements (charts, diagrams, callouts) + +## Target Audience +Who is the intended audience for presentations using this template? + +## Existing Templates +Have you tried the existing templates? Which ones are closest to what you need? +- [ ] Top Consulting Style +- [ ] Academic Style +- [ ] Zen Style +- [ ] Magazine Style +- [ ] Tech Style +- [ ] Nature Style + +## Additional Context +Any other details, inspirations, or requirements. + +## Checklist +- [ ] I have checked existing templates in the [examples](examples/) directory +- [ ] I have reviewed the [Roadmap](README.md#-roadmap) +- [ ] I can provide visual references +- [ ] I am willing to test the template once created diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..14ead04 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,85 @@ +# Pull Request + +## Description + + +## Type of Change + + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update +- [ ] Code refactoring +- [ ] Template addition +- [ ] CI/CD improvement +- [ ] Other: _______ + +## Related Issue + +Fixes #(issue number) + +## Changes Made + + +- Change 1 +- Change 2 +- Change 3 + +## Testing + + +- [ ] Tested on macOS +- [ ] Tested on Linux +- [ ] Tested on Windows +- [ ] Tested with Python 3.8 +- [ ] Tested with Python 3.9+ +- [ ] Generated sample PPTX successfully +- [ ] Verified PPTX opens in PowerPoint/LibreOffice + +### Test Cases + + +1. Test case 1 +2. Test case 2 + +## Screenshots/Examples + + +## Checklist + + +- [ ] My code follows the project's style guidelines +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published + +## Additional Context + + +## Breaking Changes + + +## Documentation + + +- [ ] README.md +- [ ] README_CN.md +- [ ] README_EN.md +- [ ] docs/technical-design.md +- [ ] docs/faq.md +- [ ] CHANGELOG.md + +## For Template Additions + + +- [ ] Template tested with multiple content types +- [ ] Added example in `examples/` directory +- [ ] Updated template list in README +- [ ] Included design specification +- [ ] Verified color accessibility +- [ ] Tested with Office 2016+ diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..c0e9333 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,43 @@ +name: CI + +on: + push: + branches: [ main, develop ] + pull_request: + branches: [ main, develop ] + +jobs: + test: + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: [ubuntu-latest, macos-latest, windows-latest] + python-version: ['3.8', '3.9', '3.10', '3.11'] + + steps: + - uses: actions/checkout@v4 + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + + - name: Lint with ruff + run: | + pip install ruff + ruff check skills/ --ignore E501,F401 + + - name: Format check with black + run: | + pip install black + black --check skills/ --line-length 100 + + - name: Run basic validation + run: | + python -c "import sys; print(f'Python {sys.version}')" + python -c "from skills.ppt_master.scripts import svg_to_pptx; print('Import successful')" diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4864301 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,38 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added +- GitHub Actions CI/CD workflow for automated testing +- CHANGELOG.md for version tracking +- Issue templates for bugs and feature requests +- Pull request template +- Comprehensive project documentation + +### Changed +- Updated LICENSE copyright year to 2026 + +## [1.0.0] - 2025-01-01 + +### Added +- Initial release of PPTskill +- 10+ professional PPT templates +- Multi-format input support (PDF, DOCX, URL, Markdown) +- OpenClaw workflow integration +- Claude Code compatibility +- 15 example projects with 229 verified slides +- Comprehensive documentation in Chinese and English + +### Features +- Native editable PPTX output (DrawingML shapes) +- Top consulting, academic, zen, magazine, tech, and nature styles +- AI editor integration (Claude Code, Cursor, VS Code) +- Privacy-first local execution + +[Unreleased]: https://github.com/AIPMAndy/PPTskill/compare/v1.0.0...HEAD +[1.0.0]: https://github.com/AIPMAndy/PPTskill/releases/tag/v1.0.0 diff --git a/LICENSE b/LICENSE index 30b9532..9c261c3 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2025 Hugo He +Copyright (c) 2025-2026 Hugo He Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal