Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 3.47 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 3.47 KB
Raw

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 community. Given the current number of developers and their limited time and resources, we cannot develop every part simultaneously. 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 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 the 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.

Fixing Bugs

HyperDbg likely contains numerous bugs and may not have considered various scenarios that could lead to system crashes. We consistently invest a substantial amount of time in addressing these issues to improve the overall user experience with HyperDbg. Your assistance in identifying and fixing bugs would be greatly appreciated. Here's a glimpse into how HyperDbg developers allocate their daily time:

Fixing bugs!

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

Would you like to add a new feature or change an existing one?

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

Do you have questions about the source code?

Ask any question about HyperDbg by opening an issue.

Source-code Tree

Here's the overview of HyperDbg's source code, including the project's relations and dependencies.


Source Tree