From 29a181752aa473c29f120be1af740d18240c3f6e Mon Sep 17 00:00:00 2001 From: yusyus Date: Mon, 20 Oct 2025 13:38:13 +0300 Subject: [PATCH] Add GitHub Project Board setup and issue templates MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add comprehensive PROJECT_BOARD_SETUP.md with 20 issues - Create 3 milestones: v1.1.0, v1.2.0, v2.0.0 - Add issue templates: feature, bug, documentation - Add PR template with checklist - Define labels for priority, type, component, status - Include setup instructions for web UI and CLI Features: - 6-column project board structure - 20 pre-defined issues covering website, core improvements, advanced features - Custom fields: Effort, Impact, Category - Success metrics and community engagement guidelines ๐Ÿค– Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- .github/ISSUE_TEMPLATE/bug_report.md | 52 +++ .github/ISSUE_TEMPLATE/documentation.md | 41 ++ .github/ISSUE_TEMPLATE/feature_request.md | 49 +- .github/PROJECT_BOARD_SETUP.md | 542 ++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 48 ++ 5 files changed, 709 insertions(+), 23 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/PROJECT_BOARD_SETUP.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..3dbbb62 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,52 @@ +--- +name: Bug Report +about: Report a bug or issue with Skill Seekers +title: '[BUG] ' +labels: 'type: bug' +assignees: '' +--- + +## ๐Ÿ› Bug Description + +A clear and concise description of what the bug is. + +## ๐Ÿ”„ Steps to Reproduce + +1. Go to '...' +2. Run command '...' +3. See error + +## โœ… Expected Behavior + +What you expected to happen. + +## โŒ Actual Behavior + +What actually happened. + +## ๐Ÿ“‹ Environment + +- **OS:** [e.g., macOS 14.0, Ubuntu 22.04, Windows 11] +- **Python Version:** [e.g., 3.10, 3.11] +- **Skill Seekers Version:** [e.g., v1.0.0] +- **Installation Method:** [pip, git clone, etc.] + +## ๐Ÿ“Š Error Output + +``` +Paste the full error message or traceback here +``` + +## ๐Ÿ“ธ Screenshots + +If applicable, add screenshots to help explain the problem. + +## ๐Ÿ” Additional Context + +- Config file used (if applicable) +- Documentation URL being scraped +- Any custom modifications made + +## ๐ŸŽฏ Possible Solution + +If you have an idea of how to fix this, please share! diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..0b7a53d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,41 @@ +--- +name: Documentation Improvement +about: Suggest improvements to documentation +title: '[DOCS] ' +labels: 'type: documentation' +assignees: '' +--- + +## ๐Ÿ“š Documentation Issue + +What documentation needs to be improved, added, or fixed? + +## ๐Ÿ“ Location + +- **File:** [e.g., README.md, docs/CLAUDE.md] +- **Section:** [e.g., Installation, Configuration] +- **URL:** [if applicable] + +## โŒ Current State + +Describe what's currently unclear, missing, or incorrect. + +## โœ… Proposed Improvement + +How should the documentation be changed? + +## ๐ŸŽฏ Target Audience + +Who would benefit from this documentation improvement? +- [ ] New users +- [ ] Advanced users +- [ ] Contributors +- [ ] API users + +## ๐Ÿ“ Additional Context + +Any additional context or examples that would help. + +## ๐Ÿ”— Related Issues + +Link to any related issues or PRs. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index cdc96e1..872b806 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,36 +1,39 @@ --- name: Feature Request -about: Suggest a new feature for Skill Seeker or MCP server +about: Suggest a new feature for Skill Seekers title: '[FEATURE] ' -labels: enhancement +labels: 'type: feature' assignees: '' --- -## Feature Description - +## ๐Ÿš€ Feature Description -## Use Case - +A clear and concise description of the feature you'd like to see. -## Proposed Solution - +## ๐Ÿ’ก Use Case -## Component -- [ ] CLI Tool -- [ ] MCP Server -- [ ] Configuration -- [ ] Documentation -- [ ] Tests +Describe the problem this feature would solve. What is the user trying to accomplish? -## Examples - +## ๐Ÿ“‹ Proposed Solution -```bash -# Example usage -``` +Describe how you envision this feature working. -## Alternatives Considered - +## ๐Ÿ”„ Alternatives Considered -## Additional Context - +Have you considered any alternative solutions or workarounds? + +## ๐Ÿ“Š Expected Impact + +- **Priority:** Low / Medium / High / Critical +- **Effort:** XS / S / M / L / XL +- **Users Affected:** Describe who would benefit + +## ๐Ÿ“ Additional Context + +Add any other context, screenshots, or examples about the feature request. + +## โœ… Acceptance Criteria + +- [ ] Criteria 1 +- [ ] Criteria 2 +- [ ] Criteria 3 diff --git a/.github/PROJECT_BOARD_SETUP.md b/.github/PROJECT_BOARD_SETUP.md new file mode 100644 index 0000000..2d31710 --- /dev/null +++ b/.github/PROJECT_BOARD_SETUP.md @@ -0,0 +1,542 @@ +# GitHub Project Board Setup for Skill Seekers + +## ๐ŸŽฏ Project Board Configuration + +### Project Name: **Skill Seekers Development Roadmap** + +### Board Type: **Table** with custom fields + +--- + +## ๐Ÿ“Š Project Columns/Status + +1. **๐Ÿ“‹ Backlog** - Ideas and future features +2. **๐ŸŽฏ Ready** - Prioritized and ready to start +3. **๐Ÿš€ In Progress** - Currently being worked on +4. **๐Ÿ‘€ In Review** - Waiting for review/testing +5. **โœ… Done** - Completed tasks +6. **๐Ÿ”„ Blocked** - Waiting on dependencies + +--- + +## ๐Ÿท๏ธ Labels to Create + +### Priority Labels +- `priority: critical` - ๐Ÿ”ด Red - Must be fixed immediately +- `priority: high` - ๐ŸŸ  Orange - Important feature/fix +- `priority: medium` - ๐ŸŸก Yellow - Normal priority +- `priority: low` - ๐ŸŸข Green - Nice to have + +### Type Labels +- `type: feature` - ๐Ÿ†• New functionality +- `type: bug` - ๐Ÿ› Something isn't working +- `type: enhancement` - โœจ Improve existing feature +- `type: documentation` - ๐Ÿ“š Documentation updates +- `type: refactor` - โ™ป๏ธ Code refactoring +- `type: performance` - โšก Performance improvements +- `type: security` - ๐Ÿ”’ Security-related + +### Component Labels +- `component: scraper` - Core scraping engine +- `component: enhancement` - AI enhancement system +- `component: mcp` - MCP server integration +- `component: cli` - Command-line tools +- `component: config` - Configuration system +- `component: website` - Website/documentation +- `component: tests` - Testing infrastructure + +### Status Labels +- `status: blocked` - Blocked by dependency +- `status: needs-discussion` - Needs team discussion +- `status: help-wanted` - Looking for contributors +- `status: good-first-issue` - Good for new contributors + +--- + +## ๐ŸŽฏ Milestones + +### Milestone 1: **v1.1.0 - Website Launch** (Due: 2 weeks) +**Goal:** Launch skillseekersweb.com with documentation + +**Issues:** +- Website landing page design +- Documentation migration +- Preset showcase gallery +- Blog setup +- SEO optimization +- Analytics integration + +### Milestone 2: **v1.2.0 - Core Improvements** (Due: 1 month) +**Goal:** Address technical debt and user feedback + +**Issues:** +- URL normalization/deduplication +- Memory optimization for large docs +- Parser fallback (lxml) +- Selector validation tool +- Incremental update system + +### Milestone 3: **v2.0.0 - Advanced Features** (Due: 2 months) +**Goal:** Major feature additions + +**Issues:** +- Parallel scraping with async +- Image/diagram extraction +- Export formats (PDF, EPUB) +- Interactive config builder +- Cloud deployment option +- Team collaboration features + +--- + +## ๐Ÿ“ Issues to Create + +### ๐ŸŒ Website Development (Milestone: v1.1.0) + +#### Issue #1: Create skillseekersweb.com Landing Page +**Labels:** `type: feature`, `priority: high`, `component: website` +**Description:** +Design and implement professional landing page with: +- Hero section with demo +- Feature highlights +- GitHub stats integration +- CTA buttons (GitHub, Docs) +- Responsive design + +**Acceptance Criteria:** +- [ ] Mobile responsive +- [ ] Load time < 2s +- [ ] SEO optimized +- [ ] Analytics tracking +- [ ] Contact form working + +--- + +#### Issue #2: Migrate Documentation to Website +**Labels:** `type: documentation`, `priority: high`, `component: website` +**Description:** +Convert existing markdown docs to website format: +- Quick Start guide +- Installation instructions +- Configuration guide +- MCP setup tutorial +- API reference + +**Files to migrate:** +- README.md +- QUICKSTART.md +- docs/CLAUDE.md +- docs/ENHANCEMENT.md +- docs/UPLOAD_GUIDE.md +- docs/MCP_SETUP.md + +--- + +#### Issue #3: Create Preset Showcase Gallery +**Labels:** `type: feature`, `priority: medium`, `component: website` +**Description:** +Interactive gallery showing all 8 preset configurations: +- Visual cards for each preset +- Download/copy config buttons +- Live preview of generated skills +- Search/filter functionality + +**Presets to showcase:** +- Godot, React, Vue, Django, FastAPI, Tailwind, Kubernetes, Astro + +--- + +#### Issue #4: Set Up Blog with Release Notes +**Labels:** `type: feature`, `priority: medium`, `component: website` +**Description:** +Create blog section for: +- Release announcements +- Tutorial articles +- Technical deep-dives +- Use case studies + +**Platform options:** +- Next.js + MDX +- Ghost CMS +- Hashnode integration + +--- + +#### Issue #5: SEO Optimization +**Labels:** `type: enhancement`, `priority: medium`, `component: website` +**Description:** +- Meta tags optimization +- Open Graph images +- Sitemap generation +- robots.txt configuration +- Schema.org markup +- Performance optimization (Lighthouse 90+) + +--- + +### ๐Ÿ”ง Core Improvements (Milestone: v1.2.0) + +#### Issue #6: Implement URL Normalization +**Labels:** `type: enhancement`, `priority: high`, `component: scraper` +**Description:** +Prevent duplicate scraping of same page with different query params. + +**Current Issue:** +- `/page?sort=asc` and `/page?sort=desc` treated as different pages +- Wastes bandwidth and storage + +**Solution:** +- Strip query parameters (configurable) +- Normalize fragments +- Canonical URL detection + +**Code Location:** `cli/doc_scraper.py:49-64` (is_valid_url) + +--- + +#### Issue #7: Memory Optimization for Large Docs +**Labels:** `type: performance`, `priority: high`, `component: scraper` +**Description:** +Current implementation loads all pages in memory (4GB+ for 40K pages). + +**Improvements needed:** +- Streaming/chunking for 10K+ pages +- Disk-based intermediate storage +- Generator-based processing +- Memory profiling + +**Code Location:** `cli/doc_scraper.py:228-251` (scrape_all) + +--- + +#### Issue #8: Add HTML Parser Fallback +**Labels:** `type: enhancement`, `priority: medium`, `component: scraper` +**Description:** +Add lxml fallback for malformed HTML. + +**Current:** Uses built-in 'html.parser' +**Proposed:** Try 'lxml' โ†’ 'html5lib' โ†’ 'html.parser' + +**Benefits:** +- Better handling of broken HTML +- Faster parsing with lxml +- More robust extraction + +**Code Location:** `cli/doc_scraper.py:66-133` (extract_content) + +--- + +#### Issue #9: Create Selector Validation Tool +**Labels:** `type: feature`, `priority: medium`, `component: cli` +**Description:** +Interactive CLI tool to test CSS selectors before full scrape. + +**Features:** +- Input URL + selector +- Preview extracted content +- Suggest alternative selectors +- Test code block detection +- Validate before scraping + +**New file:** `cli/validate_selectors.py` + +--- + +#### Issue #10: Implement Incremental Updates +**Labels:** `type: feature`, `priority: low`, `component: scraper` +**Description:** +Only re-scrape changed pages. + +**Features:** +- Track page modification times (Last-Modified header) +- Store checksums/hashes +- Compare on re-run +- Update only changed content +- Preserve local annotations + +--- + +### ๐Ÿ†• Advanced Features (Milestone: v2.0.0) + +#### Issue #11: Parallel Scraping with Async +**Labels:** `type: performance`, `priority: medium`, `component: scraper` +**Description:** +Implement async requests for faster scraping. + +**Current:** Sequential requests (slow) +**Proposed:** +- `asyncio` + `aiohttp` +- Configurable concurrency (default: 5) +- Respect rate limiting +- Thread pool for CPU-bound work + +**Expected improvement:** 3-5x faster scraping + +--- + +#### Issue #12: Image and Diagram Extraction +**Labels:** `type: feature`, `priority: low`, `component: scraper` +**Description:** +Extract images with alt-text and captions. + +**Use cases:** +- Architecture diagrams +- Flow charts +- Screenshots +- Code visual examples + +**Storage:** +- Download to `assets/images/` +- Store alt-text and captions +- Reference in SKILL.md + +--- + +#### Issue #13: Export to Multiple Formats +**Labels:** `type: feature`, `priority: low`, `component: cli` +**Description:** +Support export beyond Claude .zip format. + +**Formats:** +- Markdown (flat structure) +- PDF (with styling) +- EPUB (e-book format) +- Docusaurus (documentation site) +- MkDocs format +- JSON API format + +**New file:** `cli/export_skill.py` + +--- + +#### Issue #14: Interactive Config Builder +**Labels:** `type: feature`, `priority: medium`, `component: cli` +**Description:** +Web-based or TUI config builder. + +**Features:** +- Test URL selector in real-time +- Preview categorization +- Estimate page count live +- Save/export config +- Import from existing site structure + +**Options:** +- Terminal UI (textual library) +- Web UI (Flask + React) +- Electron app + +--- + +#### Issue #15: Cloud Deployment Option +**Labels:** `type: feature`, `priority: low`, `component: deployment` +**Description:** +Deploy as cloud service. + +**Features:** +- Web interface for scraping +- Job queue system +- Scheduled re-scraping +- Multi-user support +- API endpoints + +**Tech stack:** +- Backend: FastAPI +- Queue: Celery + Redis +- Database: PostgreSQL +- Hosting: Docker + Kubernetes + +--- + +### ๐Ÿ› Bug Fixes + +#### Issue #16: Fix Package Path in Output +**Labels:** `type: bug`, `priority: low`, `component: cli` +**Description:** +doc_scraper.py shows wrong path: `/mnt/skills/examples/skill-creator/scripts/cli/package_skill.py` + +**Expected:** `python3 cli/package_skill.py output/godot/` + +**Code Location:** `cli/doc_scraper.py:789` (end of main()) + +--- + +#### Issue #17: Handle Network Timeouts Gracefully +**Labels:** `type: bug`, `priority: medium`, `component: scraper` +**Description:** +Improve error handling for network failures. + +**Current behavior:** Crashes on timeout +**Expected:** Retry with exponential backoff, skip after 3 attempts + +--- + +### ๐Ÿ“š Documentation + +#### Issue #18: Create Video Tutorial Series +**Labels:** `type: documentation`, `priority: medium`, `component: website` +**Description:** +YouTube tutorial series: +1. Quick Start (5 min) +2. Custom Config Creation (10 min) +3. MCP Integration Guide (8 min) +4. Large Documentation Handling (12 min) +5. Enhancement Deep Dive (15 min) + +--- + +#### Issue #19: Write Contributing Guide +**Labels:** `type: documentation`, `priority: medium`, `component: documentation` +**Description:** +Create CONTRIBUTING.md with: +- Code style guidelines +- Testing requirements +- PR process +- Issue templates +- Development setup + +--- + +### ๐Ÿงช Testing + +#### Issue #20: Increase Test Coverage to 90%+ +**Labels:** `type: tests`, `priority: medium`, `component: tests` +**Description:** +Current: 96 tests +Target: 150+ tests with 90% coverage + +**Areas needing coverage:** +- Edge cases in language detection +- Error handling paths +- MCP server tools +- Enhancement scripts +- Packaging utilities + +--- + +## ๐ŸŽฏ Custom Fields for Project Board + +Add these custom fields to track more information: + +1. **Effort** (Single Select) + - XS (< 2 hours) + - S (2-4 hours) + - M (1-2 days) + - L (3-5 days) + - XL (1-2 weeks) + +2. **Impact** (Single Select) + - Low + - Medium + - High + - Critical + +3. **Category** (Single Select) + - Feature + - Bug Fix + - Documentation + - Infrastructure + - Marketing + +4. **Assignee** (Person) +5. **Due Date** (Date) +6. **Dependencies** (Text) - Link to blocking issues + +--- + +## ๐Ÿ“‹ Quick Setup Steps + +### Option 1: Manual Setup (Web Interface) + +1. **Go to:** https://github.com/yusufkaraaslan/Skill_Seekers +2. **Click:** "Projects" tab โ†’ "New project" +3. **Select:** "Table" layout +4. **Name:** "Skill Seekers Development Roadmap" +5. **Create columns:** Backlog, Ready, In Progress, In Review, Done, Blocked +6. **Add custom fields** (listed above) +7. **Go to "Issues"** โ†’ Create labels (copy from above) +8. **Go to "Milestones"** โ†’ Create 3 milestones +9. **Create issues** (copy descriptions above) +10. **Add issues to project board** + +### Option 2: GitHub CLI (After Installation) + +```bash +# Install GitHub CLI +brew install gh # macOS +# or +sudo apt install gh # Linux + +# Authenticate +gh auth login + +# Create project (beta feature) +gh project create --title "Skill Seekers Development Roadmap" --owner yusufkaraaslan + +# Create labels +gh label create "priority: critical" --color "d73a4a" +gh label create "priority: high" --color "ff9800" +gh label create "priority: medium" --color "ffeb3b" +gh label create "priority: low" --color "4caf50" +gh label create "type: feature" --color "0052cc" +gh label create "type: bug" --color "d73a4a" +gh label create "type: enhancement" --color "a2eeef" +gh label create "component: scraper" --color "5319e7" +gh label create "component: website" --color "1d76db" + +# Create milestone +gh milestone create "v1.1.0 - Website Launch" --due "2025-11-03" + +# Create issues (example) +gh issue create --title "Create skillseekersweb.com Landing Page" \ + --body "Design and implement professional landing page..." \ + --label "type: feature,priority: high,component: website" \ + --milestone "v1.1.0 - Website Launch" +``` + +--- + +## ๐Ÿš€ Recommended Priority Order + +### Week 1: Website Foundation +1. Issue #1: Landing page +2. Issue #2: Documentation migration +3. Issue #5: SEO optimization + +### Week 2: Core Improvements +4. Issue #6: URL normalization +5. Issue #7: Memory optimization +6. Issue #9: Selector validation tool + +### Week 3-4: Polish & Growth +7. Issue #3: Preset showcase +8. Issue #4: Blog setup +9. Issue #18: Video tutorials + +--- + +## ๐Ÿ“Š Success Metrics + +Track these KPIs on your project board: + +- **GitHub Stars:** Target 1,000+ by end of month +- **Website Traffic:** Target 500+ visitors/week +- **Issue Resolution:** Close 10+ issues/week +- **Documentation Coverage:** 100% of features documented +- **Test Coverage:** 90%+ +- **Response Time:** Reply to issues within 24 hours + +--- + +## ๐Ÿค Community Engagement + +Add these as recurring tasks: + +- **Weekly:** Respond to GitHub issues/PRs +- **Bi-weekly:** Publish blog post +- **Monthly:** Release new version +- **Quarterly:** Major feature release + +--- + +This project board structure will help organize development, track progress, and coordinate with contributors! diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..16e61df --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,48 @@ +# Pull Request + +## ๐Ÿ“‹ Description + +Brief description of changes made. + +## ๐Ÿ”— Related Issues + +Closes #(issue number) +Relates to #(issue number) + +## ๐ŸŽฏ 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 +- [ ] โšก Performance improvement +- [ ] ๐Ÿงช Test update + +## โœ… Checklist + +- [ ] My code follows the style guidelines of this project +- [ ] 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 + +## ๐Ÿงช Testing + +Describe the tests you ran to verify your changes. + +**Test Configuration:** +- Python version: +- OS: +- Dependencies installed: + +## ๐Ÿ“ธ Screenshots (if applicable) + +Add screenshots to demonstrate visual changes. + +## ๐Ÿ“ Additional Notes + +Any additional information reviewers should know.