Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 2.62 KB

Contribution

First off, thanks for taking the time to contribute! ❤️

HyperDbg is a large-scale project that requires a lot of time and effort from the commiunity. Given the current number of developers and their limited time and resources, we cannot develop every part simulteniously. Therefore, new developers are warmly welcomed to join and add their contributions to the project. Here, we made a list of potential improvements that you can contribute on. Feel free to open up an issue if you think you have any ideas that would make a good addition to the list, or if you want to implement one of the below items, or if you'd like to discuss about a question you might have.

Things to work on

  • Writing blog posts about use-cases of HyperDbg
  • Troubleshooting problems with running on Hyper-V's nested virtualization
  • Troubleshooting problems with running on VirtualBox's nested virtualization
  • Supporting kdnet (sending data over net)
  • Adding an assembler to the project
  • Enhancing HyperDbg's Transparent Mode, especially anti-hypervisor methods
  • Making a SoftICE-style GUI
  • Enhancing and adding more features to the '.pe' command
  • Anything else you might find interesting ;)

This list will be updated frequently.

Coding Style

If you want to create a pull request please read coding-style, doxygen-style, and command-style in the case you want a new feature, or report a bug, please explain it in issues.

FAQ

Here's some Frequently Asked Questions which may help with your moving process

Did you write a patch that fixes a bug?

Open a new GitHub pull request with the patch and also ensure the PR description clearly describes the problem and solution.

Suggesting Enhancements

If you want to submit an enhancement or suggestion for HyperDbg, including completely new features and minor improvements to existing functionality please explain it in issues.

Do you intend to add a new feature or change an existing one?

Suggest your change by openning an issue and start writing code.

Do you have questions about the source code?

Ask any question about HyperDbg by opening an issue.