Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (29 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.63 KB

Contributing to code-autopsy

Thanks for your interest! Here's how to contribute.

Ways to Contribute

🐛 Bug Reports

Found a diagnostic that gives wrong results? Open an issue.

💡 New Diagnostics

Have an idea for a new diagnostic? Open a feature request. Include:

  • What the diagnostic measures
  • Why it matters
  • Example of what it would catch

🌍 Language Support

code-autopsy works best with TypeScript/JavaScript. PRs that improve detection patterns for Python, Rust, Go, Java, or other languages are welcome.

📊 Report Design

The HTML report is the product. If you can make it look better, more informative, or more accessible — that's a high-value contribution.

📝 Example Reports

Run code-autopsy on an open-source project and contribute the report as an example. Include the project name, what was found, and what the maintainers said.

Pull Request Process

  1. Fork the repo
  2. Create a branch: git checkout -b feat/my-change
  3. Make your changes
  4. Test by running the skill on a real codebase
  5. Submit a PR with a clear description of what changed and why

Style Guide

  • SKILL.md is the source of truth — keep it concise, quantified, and actionable
  • HTML reports must be self-contained (no external dependencies)
  • Every diagnostic must produce a number (score), not just text
  • Prioritize precision over recall — no false positives

Code of Conduct

Be constructive. We're here to make codebases healthier, not to gatekeep or judge.