Skip to content

Fix markdown formatting issues and add contribution infrastructure#22

Open
mohitgauniyal wants to merge 2 commits intoanthropics:mainfrom
mohitgauniyal:fix/markdown-formatting-and-contrib-guidelines
Open

Fix markdown formatting issues and add contribution infrastructure#22
mohitgauniyal wants to merge 2 commits intoanthropics:mainfrom
mohitgauniyal:fix/markdown-formatting-and-contrib-guidelines

Conversation

@mohitgauniyal
Copy link

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 (~~text without closing) that was rendering incorrectly in markdown viewers.

Solution: Removed all malformed strikethrough syntax across 29 files in 9 plugins.

Example Fix:

- If **~~project tracker** is connected:
+ If **project tracker** is connected:

- I'll offer to create a draft in ~~email
+ I'll offer to create a draft in email

Impact:

  • Improves documentation readability
  • Fixes rendering in GitHub, VS Code, and other markdown viewers
  • Removes confusion for new users and contributors

2. Added Contribution Guidelines (MEDIUM PRIORITY)

Added: CONTRIBUTING.md - Comprehensive 500+ line contribution guide

Includes:

  • Code of conduct reference
  • How to report bugs and suggest features
  • Plugin structure requirements
  • Development guidelines for skills and commands
  • Pull request process and checklist
  • Style guidelines (markdown, JSON, naming)

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.md

Benefits: Structured issue reporting, faster triage, better information gathering

4. Added Pull Request Template (MEDIUM PRIORITY)

Added: .github/PULL_REQUEST_TEMPLATE.md

Benefits: Standardized PR format, ensures complete information, improves review efficiency

5. Added CI/CD Validation (MEDIUM PRIORITY)

Added: .github/workflows/validate.yml

Validates:

  • JSON syntax in all .json files
  • plugin.json schema compliance
  • Malformed markdown strikethrough
  • Trailing whitespace
  • Plugin structure (required files)

Benefits: 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

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have updated the documentation accordingly
  • My changes generate no new warnings
  • I have tested my changes thoroughly
  • All JSON files are valid
  • All markdown files render correctly
  • No sensitive data included
  • No breaking changes

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


- 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant