Contribute

If you’re reading this section, you’re probably interested in contributing to SSH-MITM. Welcome and thanks for your interest in contributing!

Please take a look at the documentation, familiarize yourself with using SSH-MITM, and introduce yourself to the community and share what area of the project you are interested in working on.

We have labeled some issues as good first issue or help wanted that we believe are good examples of small, self-contained changes. We encourage those that are new to the code base to implement and/or ask questions about these issues. You are not required to ask for a permission to work on such issue, but if you do and do not get a reply within 48 hours please assume that no one else is working on it (even if someone previously volunteered) and open a pull request with proposed implementation. If you are not certain about the implementation, using draft pull requests is encouraged.

If you believe you’ve found a security vulnerability in SSH-MITM, please report it to support@ssh-mitm.at.

We are very pleased to have you as a contributor, and we hope you will find valuable your impact on the projects. Thank you for sharing your interests, ideas, and skills with us.

Do I really have something to contribute?

Absolutely . There are always ways to contribute to this community! Whether it is is contributing code, improving documentation and communications, teaching others, or participating in conversations in the community, we welcome and value your contribution!

What kinds of contributions can I make?

The following sections try to provide inspirations for different ways that you can contribute to SSH-MITM. They’re non-complete - if you can think up any way to make an improvement, we appreciate it!

Improving documentation

One of the most important parts of SSH-MITM is its documentation. Good documentation makes it easier for users to learn how to use the tool. It also makes it easier to teach others, and to maintain and improve the code itself. There are many ways to improve documentation, such as reading tutorials and reporting confusing parts, finding type-os and minor errors in docs, writing your own guides and tutorials, improving docstrings within the code, and improving documentation style and design.

Improving code

We recommend checking out the Developer Guide for more information about how you can find the right project to contribute to, and where to go next.

Participating in the community

The most important part of SSH-MITM is its community - this is a large and diverse group of people spread across the globe. One of the best ways to contribute to SSH-MITM is to simply be a positive and helpful member of this community. Whether it participating in online conversations, offering to help others, coming to community meetings, or teaching others about SSH-MITM, there are many ways to improve the SSH-MITM community.