|
| 1 | +## Issues and Contributing to vm-console-client-python |
| 2 | + |
| 3 | +Please note the majority of this repository's contents are auto generated based on the latest Rapid7 InsightVM/Nexpose |
| 4 | +Console Swagger file. No product related bugs or enhancements to InsightVM/Nexpose will be addressed here. Any issues |
| 5 | +related to the swagger file contents or product related bugs will need to be addressed with Rapid7 Support in order |
| 6 | +for the product changes to be made. |
| 7 | + |
| 8 | +If your bug/enhancement is related to this repository or any build/helper files, please reference the information below. |
| 9 | +Any contributions will routinely result in a new version of the rapid7_vm_console Python libarary and |
| 10 | +[release](https://github.com/rapid7/vm-console-client-python/releases). |
| 11 | + |
| 12 | +#### Contributing to vm-console-client-python |
| 13 | + |
| 14 | +The users and maintainers of vm-console-client-python would greatly appreciate any contributions you can make to the project. |
| 15 | +These contributions typically come in the form of filed bugs/issues or pull requests (PRs). Once approved and merged, |
| 16 | +contributions will be included with tagged releases and the associated Python library. |
| 17 | + |
| 18 | +#### Contributing Issues / Bug Reports |
| 19 | + |
| 20 | +If you encounter any bugs or problems, please file them |
| 21 | +[here](https://github.com/rapid7/vm-console-client-python/issues/new), providing as much detail as possible. If the bug is |
| 22 | +simple and you feel comfortable making the fix, feel free making a Pull Request to help contribute to the community. |
| 23 | + |
| 24 | +#### Contributing Enhancements |
| 25 | + |
| 26 | +When contributing enhancements to the repository, please ensure the PR template is filled out fully with details of how |
| 27 | +the changes were tested, the reasoning for the changes, and environment details. While we encourage community |
| 28 | +contributions, not all PRs will be merged as they may not fit the holistic purpose of this project. If you intend to |
| 29 | + extend the functionality for your own purposes, feel free to fork the repository and work with it as you please. |
| 30 | + |
| 31 | +When contributing, please leverage your own fork of the repo, create a |
| 32 | +[pull request](https://github.com/rapid7/vm-console-client-python/pulls) with the change, and then a |
| 33 | +maintainer will review the changes prior to merging and building a new image. |
0 commit comments