This repository has been archived by the owner on Sep 10, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Addition of Github templates for repository
- Loading branch information
Showing
3 changed files
with
101 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
## Issues and Contributing to vm-console-client-python | ||
|
||
Please note the majority of this repository's contents are auto generated based on the latest Rapid7 InsightVM/Nexpose | ||
Console Swagger file. No product related bugs or enhancements to InsightVM/Nexpose will be addressed here. Any issues | ||
related to the swagger file contents or product related bugs will need to be addressed with Rapid7 Support in order | ||
for the product changes to be made. | ||
|
||
If your bug/enhancement is related to this repository or any build/helper files, please reference the information below. | ||
Any contributions will routinely result in a new version of the rapid7_vm_console Python libarary and | ||
[release](https://github.com/rapid7/vm-console-client-python/releases). | ||
|
||
#### Contributing to vm-console-client-python | ||
|
||
The users and maintainers of vm-console-client-python would greatly appreciate any contributions you can make to the project. | ||
These contributions typically come in the form of filed bugs/issues or pull requests (PRs). Once approved and merged, | ||
contributions will be included with tagged releases and the associated Python library. | ||
|
||
#### Contributing Issues / Bug Reports | ||
|
||
If you encounter any bugs or problems, please file them | ||
[here](https://github.com/rapid7/vm-console-client-python/issues/new), providing as much detail as possible. If the bug is | ||
simple and you feel comfortable making the fix, feel free making a Pull Request to help contribute to the community. | ||
|
||
#### Contributing Enhancements | ||
|
||
When contributing enhancements to the repository, please ensure the PR template is filled out fully with details of how | ||
the changes were tested, the reasoning for the changes, and environment details. While we encourage community | ||
contributions, not all PRs will be merged as they may not fit the holistic purpose of this project. If you intend to | ||
extend the functionality for your own purposes, feel free to fork the repository and work with it as you please. | ||
|
||
When contributing, please leverage your own fork of the repo, create a | ||
[pull request](https://github.com/rapid7/vm-console-client-python/pulls) with the change, and then a | ||
maintainer will review the changes prior to merging and building a new image. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
## Issues and Contributing | ||
<!--- Provide a general summary of the issue in the Title above. --> | ||
|
||
<!-- Please note that only issues related to the build and helper files of this repository will be addressed here. Any | ||
issues related to the API Swagger file or API bugs will need to be addressed with Rapid7 Support. This repository is | ||
not officially supported by Rapid7 and has been created by an internal team that also leverages the InsightVM/Nexpose | ||
API with Python. The team uses best effort to address issues as quickly as possible, but appreciates input from the | ||
community as well. --> | ||
|
||
### Expected Behavior | ||
<!--- If you're describing a bug, tell us what should happen. --> | ||
<!--- If you're suggesting a change/improvement, tell us how it should work. --> | ||
|
||
### Actual Behavior | ||
<!--- If describing a bug, tell us what happens instead of the expected behavior. --> | ||
<!--- If suggesting a change/improvement, explain the difference from current behavior. --> | ||
|
||
### Possible Solution | ||
<!--- Suggest a fix for the bug, --> | ||
<!--- or ideas how to implement the improvement or change. --> | ||
|
||
### Steps to Reproduce (for bugs) | ||
<!--- Provide a set of steps to reproduce this bug; please be as descriptive as possible. --> | ||
<!--- Please include code to reproduce, if relevant. --> | ||
|
||
Python code that reproduces the issue: | ||
```python | ||
print("this is only an example Python code block") | ||
``` | ||
|
||
### Your Environment | ||
* Library version or repository branch: | ||
* Python version: | ||
* Operating System and version: | ||
* InsightVM/Nexpose product version: | ||
|
||
### Other relevant information |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
<!--- Provide a general summary of your changes in the Title above --> | ||
|
||
### Description | ||
<!--- Describe your changes in detail --> | ||
|
||
|
||
### Motivation and Context | ||
<!--- Why is this change required? What problem does it solve? --> | ||
<!--- If it fixes an open issue, please link to the issue here. --> | ||
|
||
|
||
### How Has This Been Tested? | ||
<!--- Please describe in detail how you tested your changes. --> | ||
|
||
|
||
### Types of changes | ||
<!--- What types of changes does your code introduce? Remove any that do not apply: --> | ||
- Bug fix (non-breaking change which fixes an issue) | ||
- New feature (non-breaking change which adds functionality) | ||
- Breaking change (fix or feature that would cause existing functionality to change) | ||
|
||
|
||
### Checklist: | ||
<!--- After submitting the PR, check all of the boxes that apply. --> | ||
<!--- You may remove any that do not apply or add additional checks as reminders. --> | ||
- [ ] I have updated the documentation accordingly (if changes are required). | ||
- [ ] I have tested the changes locally. | ||
|
||
|
||
### Miscellaneous Details: | ||
<!--- Provide any additional details you feel are relevant. --> |