-
Notifications
You must be signed in to change notification settings - Fork 2
chore: optimize project metadata and CI/CD #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| # Pull Request | ||
|
|
||
| ## Description | ||
| <!-- Provide a clear and concise description of your changes --> | ||
|
|
||
| ## Type of Change | ||
| <!-- Mark the relevant option with an 'x' --> | ||
|
|
||
| - [ ] 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 | ||
| <!-- Link to the issue this PR addresses --> | ||
| Fixes #(issue number) | ||
|
|
||
| ## Changes Made | ||
| <!-- List the specific changes made in this PR --> | ||
|
|
||
| - Change 1 | ||
| - Change 2 | ||
| - Change 3 | ||
|
|
||
| ## Testing | ||
| <!-- Describe the tests you ran to verify your changes --> | ||
|
|
||
| - [ ] 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 | ||
| <!-- Describe specific test cases --> | ||
|
|
||
| 1. Test case 1 | ||
| 2. Test case 2 | ||
|
|
||
| ## Screenshots/Examples | ||
| <!-- If applicable, add screenshots or example outputs --> | ||
|
|
||
| ## Checklist | ||
| <!-- Mark completed items with an 'x' --> | ||
|
|
||
| - [ ] 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 | ||
| <!-- Add any other context about the PR here --> | ||
|
|
||
| ## Breaking Changes | ||
| <!-- If this is a breaking change, describe the impact and migration path --> | ||
|
|
||
| ## Documentation | ||
| <!-- List any documentation that needs to be updated --> | ||
|
|
||
| - [ ] README.md | ||
| - [ ] README_CN.md | ||
| - [ ] README_EN.md | ||
| - [ ] docs/technical-design.md | ||
| - [ ] docs/faq.md | ||
| - [ ] CHANGELOG.md | ||
|
|
||
| ## For Template Additions | ||
| <!-- Complete this section if adding a new template --> | ||
|
|
||
| - [ ] 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+ |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
After the Ruff step is addressed, this newly added Black gate still fails on the current repository: Useful? React with 👍 / 👎. |
||
|
|
||
| - 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')" | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
This validation command cannot succeed from a fresh checkout because the repository contains Useful? React with 👍 / 👎. |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this workflow I ran the exact command added here (
ruff check skills/ --ignore E501,F401); it exits 1 with 63 existing violations, includingF821 Undefined name argparseinskills/ppt-master/scripts/svg_finalize/crop_images.py. Since Ruff's help says it runs on the supplied files/directories, every push/PR matrix job will stop at this new step until the repo is fixed, the rule set is tuned, or the check is scoped to code that already passes.Useful? React with 👍 / 👎.