This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Contribution Guidelines

How to contribute to the docs

Thank you for your interest in contributing to vulnman! Here are some of the many ways in which you can help:

1 - Project Security

Information about the project security

This page provides a central hub for topics pertaining to the security of the vulnman project.

Reporting security issues in Vulnman

If you have discovered a security issue affecting vulnman, then we would be more than happy to hear from you!

If our investigation confirms that an issue affects vulnman, we will patch it within a reasonable time and release a public post that describes the issue, discusses the potential impact of the vulnerability, references applicable patches or workarounds, and credits the discoverer. Please use this address:

vulnman-project+security at riseup dot net

2 - Testing Releases

How to test upcoming releases

Testing new vulnman releases and updates is one of the most helpful ways in which you can contribute to the vulnman project.

Warning: Software testing is intended for advanced users and developers. You should only attempt to do this if you know what you’re doing. Never rely on code that is in testing for critical work!

The Main Branch

The main branch is used for development purposes and should not be used for critical work. If you want to test upcoming releases, download the code from the main branch.

If you are using docker, use the main tag, which is build on every commit in the main branch.

Providing feedback

Since the whole point of testing software is to discover and fix bugs, your feedback is an essential part of this process.

3 - How To Edit The Documentation

To Be Done