3.9 KiB
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.
Things to Work on
Please make sure to create a discussion or an issue, or even better, join the HyperDbg groups (Telegram, Discord, Matrix) on social media. Discuss the way you want to implement your changes and inform developers, because we often see people simultaneously working on the same issue. To avoid this collision, make sure to inform us before you start developing.
Working on an Idea or a Task
- We have a wide range of ideas and tasks that you might be interested in working on. You can choose a task and start working on it, and if you have any questions or need clarification, feel free to ask. This list will be updated frequently.
Other Things to Work on
- Writing blog posts and creating videos about use-cases of HyperDbg (make sure to add it to the awesome repository).
- Fixing unresolved GitHub issues.
- Any other interesting ideas you might find! (Let's have a discussion before working on them.)
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:
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.
