[DOCUMENTATION]
Access Level: PUBLIC Documentation Status: ACTIVE Last Updated: 2026-04-02
[DOCUMENTATION_SECTIONS]
[CONTRIBUTING GUIDE]
CONTENT_VIEWER
Contributing to EvilMutex
Welcome! We're excited to have you contribute to our malware mutex intelligence platform.
Quick Start
- Fork the repository
- Create a new branch
- Add your malware signatures or improvements
- Test locally with
npm run dev - Submit a pull request
Adding Malware Signatures
Simple Structure
Just put your YAML file directly in the signatures/ folder:
signatures/wannacry.yamlsignatures/lockbit.yamlsignatures/emotet.yaml
File Naming
Use lowercase with hyphens: wannacry.yaml, lockbit.yaml
YAML Template
malware_info:
family: "MalwareName"
aliases: ["Alias1", "Alias2"]
description: "Brief description"
first_seen: "2023"
category: "ransomware" # or "rat", "trojan", "other"
primary_tags: ["windows", "encryption", "bitcoin"]
mutexes:
- name: "MutexNameHere"
references:
- "https://source1.com"
- "https://source2.com"
date_added: "2025-01-11"
analyst: "@adhikara13"
Requirements
- Exact mutex names - Copy them exactly as they appear
- Public sources - Each mutex needs at least one reference
- Your GitHub username - In the analyst field
- Today's date - When you added it
Code Changes
Frontend (Website)
- Located in
website/folder - Uses Vue.js + TypeScript + Tailwind CSS
- Test with
cd website && npm run dev
Testing
Before submitting:
- Run
npm run devto test locally - Check your data appears on the website
- Try searching for your malware
Pull Request Tips
- Clear title - "Add Cobalt Strike mutex signatures"
- Explain what you added - Brief description
- Link sources - Where you found the mutex info
- Keep it focused - One malware family per PR is ideal
What We're Looking For
High Priority
- New malware families - Especially recent ones
- Missing mutexes - Add to existing families
- Better sources - More recent/detailed references
Medium Priority
- UI improvements - Better search, filters, layout
- Documentation - Clearer guides and examples
- Bug fixes - Anything broken or confusing
Need Help?
- Schema details: Check the Schema Documentation tab
- Technical setup: See README.md
- Questions: Open an issue with the "question" label
Thanks for helping make malware research better!