Skip to content
This repository was archived by the owner on Sep 10, 2024. It is now read-only.

Commit 3e04e5a

Browse files
committed
Addition of Github templates for repository
1 parent d67f4f1 commit 3e04e5a

File tree

3 files changed

+101
-0
lines changed

3 files changed

+101
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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.

.github/ISSUE_TEMPLATE.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## Issues and Contributing
2+
<!--- Provide a general summary of the issue in the Title above. -->
3+
4+
<!-- Please note that only issues related to the build and helper files of this repository will be addressed here. Any
5+
issues related to the API Swagger file or API bugs will need to be addressed with Rapid7 Support. This repository is
6+
not officially supported by Rapid7 and has been created by an internal team that also leverages the InsightVM/Nexpose
7+
API with Python. The team uses best effort to address issues as quickly as possible, but appreciates input from the
8+
community as well. -->
9+
10+
### Expected Behavior
11+
<!--- If you're describing a bug, tell us what should happen. -->
12+
<!--- If you're suggesting a change/improvement, tell us how it should work. -->
13+
14+
### Actual Behavior
15+
<!--- If describing a bug, tell us what happens instead of the expected behavior. -->
16+
<!--- If suggesting a change/improvement, explain the difference from current behavior. -->
17+
18+
### Possible Solution
19+
<!--- Suggest a fix for the bug, -->
20+
<!--- or ideas how to implement the improvement or change. -->
21+
22+
### Steps to Reproduce (for bugs)
23+
<!--- Provide a set of steps to reproduce this bug; please be as descriptive as possible. -->
24+
<!--- Please include code to reproduce, if relevant. -->
25+
26+
Python code that reproduces the issue:
27+
```python
28+
print("this is only an example Python code block")
29+
```
30+
31+
### Your Environment
32+
* Library version or repository branch:
33+
* Python version:
34+
* Operating System and version:
35+
* InsightVM/Nexpose product version:
36+
37+
### Other relevant information

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
### Description
4+
<!--- Describe your changes in detail -->
5+
6+
7+
### Motivation and Context
8+
<!--- Why is this change required? What problem does it solve? -->
9+
<!--- If it fixes an open issue, please link to the issue here. -->
10+
11+
12+
### How Has This Been Tested?
13+
<!--- Please describe in detail how you tested your changes. -->
14+
15+
16+
### Types of changes
17+
<!--- What types of changes does your code introduce? Remove any that do not apply: -->
18+
- Bug fix (non-breaking change which fixes an issue)
19+
- New feature (non-breaking change which adds functionality)
20+
- Breaking change (fix or feature that would cause existing functionality to change)
21+
22+
23+
### Checklist:
24+
<!--- After submitting the PR, check all of the boxes that apply. -->
25+
<!--- You may remove any that do not apply or add additional checks as reminders. -->
26+
- [ ] I have updated the documentation accordingly (if changes are required).
27+
- [ ] I have tested the changes locally.
28+
29+
30+
### Miscellaneous Details:
31+
<!--- Provide any additional details you feel are relevant. -->

0 commit comments

Comments
 (0)