Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 2.25 KB

contribution.md

File metadata and controls

79 lines (53 loc) · 2.25 KB

🤝 Contributing to Shellcode Tester Pro

Thank you for your interest in contributing to Shellcode Tester Pro!
This is an open-source tool designed to safely analyze, emulate, and reverse engineer shellcodes using a graphical interface built in Python.

We welcome feature suggestions, bug fixes, new plugins, and documentation improvements!

📦 Plugin Contributions

Shellcode Tester Pro supports a plugin system to extend its functionality.
You can easily create and share your own plugins. Follow these simple steps:

🔧 Plugin Structure

  • Create a Python file in the plugins/ folder.
  • Your plugin must contain a register(app) function.
  • Inside register(), you can add tabs, buttons, or hooks to the existing GUI.

Example:

def register(app):
    from PyQt5.QtWidgets import QWidget, QLabel, QVBoxLayout
    tab = QWidget()
    layout = QVBoxLayout()
    layout.addWidget(QLabel("Hello from my plugin!"))
    tab.setLayout(layout)
    app.tabs.addTab(tab, "MyPlugin")

📝 Name your file clearly (e.g., my_plugin.py) and test before submitting.

🧠 Ideas to Contribute

Here are a few suggestions on how you can help improve this project:

  • 🔍 Add detection for more shellcode obfuscation techniques.
  • 🧬 Improve the fingerprinting module.
  • 🧪 Integrate sandbox/emulation engines.
  • 📚 Translate the GUI and docs to other languages.
  • 📦 Build new analysis or visualization plugins.
  • 🚀 Suggest performance optimizations.

🗂️ Submitting Your Contribution

  1. Fork this repository.
  2. Create a new branch (git checkout -b my-feature).
  3. Commit your changes (git commit -m "Added feature XYZ").
  4. Push to your branch (git push origin my-feature).
  5. Create a Pull Request 🎉

Make sure your code follows the style of the project and includes comments where necessary.

📞 Questions?

Need help or have an idea?
Feel free to open an Issue or reach out via:

❤️ Credits

Created by Joas Antonio dos Santos
Feel free to share the project and help make it better together!

Let's build a safer and smarter shellcode analyzer. Your contribution matters. 💉