Fix markdown formatting issues and add contribution infrastructure#22
Open
mohitgauniyal wants to merge 2 commits intoanthropics:mainfrom
Open
Conversation
- Fix malformed strikethrough syntax in 29 files across 9 plugins - Add CONTRIBUTING.md with comprehensive guidelines - Add GitHub issue templates (bug, feature, plugin submission) - Add pull request template - Add CI/CD validation workflow for JSON and markdown Fixes markdown rendering issues that made documentation harder to read. Adds infrastructure to enable community contributions and ensure quality.
- Add CONTRIBUTING.md with comprehensive guidelines - Add GitHub issue templates (bug, feature, plugin submission) - Add pull request template - Add CI/CD validation workflow
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request: Fix Markdown Formatting & Add Contribution Infrastructure
Summary
This PR addresses critical markdown formatting issues and adds essential contribution infrastructure to improve the developer experience and community engagement for the knowledge-work-plugins repository.
Changes Overview
1. Fixed Markdown Formatting Issues (HIGH PRIORITY)
Problem: 29 files contained malformed strikethrough syntax (
~~textwithout closing) that was rendering incorrectly in markdown viewers.Solution: Removed all malformed strikethrough syntax across 29 files in 9 plugins.
Example Fix:
Impact:
2. Added Contribution Guidelines (MEDIUM PRIORITY)
Added:
CONTRIBUTING.md- Comprehensive 500+ line contribution guideIncludes:
Benefits: Lowers barrier to entry, standardizes contribution process, improves code quality
3. Added GitHub Issue Templates (MEDIUM PRIORITY)
Added:
.github/ISSUE_TEMPLATE/bug_report.md.github/ISSUE_TEMPLATE/feature_request.md.github/ISSUE_TEMPLATE/plugin_submission.mdBenefits: Structured issue reporting, faster triage, better information gathering
4. Added Pull Request Template (MEDIUM PRIORITY)
Added:
.github/PULL_REQUEST_TEMPLATE.mdBenefits: Standardized PR format, ensures complete information, improves review efficiency
5. Added CI/CD Validation (MEDIUM PRIORITY)
Added:
.github/workflows/validate.ymlValidates:
.jsonfilesBenefits: Catches errors before merge, automated quality checks, maintains consistency
Files Changed
Modified: 29 files (markdown formatting fixes)
Added: 6 files (contribution infrastructure)
Deleted: 0 files
Testing
Manual Testing Completed
✅ Verified all fixed files render correctly in VS Code
✅ Checked GitHub markdown preview
✅ All JSON files pass validation
✅ All plugin.json files have required fields
✅ No files were deleted or moved
Breaking Changes
❌ NONE - All changes are backwards compatible
Risk Level
✅ LOW - Changes are cosmetic and additive
Checklist
Impact
For Users: Better documentation, clearer instructions, professional appearance
For Contributors: Lower barrier to entry, faster PR process, clear guidelines
For Maintainers: Automated quality checks, standardized format, reduced workload