Skip to content

Commit

Permalink
housekeeping stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
carlmontanari committed Feb 18, 2020
1 parent c27d849 commit 95ee04c
Show file tree
Hide file tree
Showing 5 changed files with 80 additions and 4 deletions.
19 changes: 19 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Contributing
=======

Thanks for thinking about contributing to scrapli! Contributions are not expected, but are quite welcome.

Contributions of all kinds are welcomed -- typos, doc updates, adding examples, bug fixes, and feature adds


Some notes on contributing:

- Please open an issue to discuss any bug fixes, feature adds, or really any thing that could result in a pull
request. This allows us to all be on the same page, and could save everyone some extra work!
- Once we've discussed any changes, pull requests are of course welcome and very much appreciated!
- All PRs should pass tests -- checkout the Makefile for some shortcuts for linting/testing
- Please include tests! Even simple/basic tests are better than nothing -- it helps make sure changes in the future
don't break functionality or make things act in unexpected ways!
- If doing any significant work on scrapli -- particularly on channel, transport, or drivers, take some time to get
familiar with, vrnetlab. All functional tests -- in order to allow everyone to test functional things in a
consistent fashion -- rely on vrnetlab!
6 changes: 2 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,8 @@ If applicable, add screenshots to help explain your problem.

**OS (please complete the following information):**
- OS: [e.g. Ubuntu, MacOS, etc. - Note this is *not* tested on Windows and likely will not be supported]
- nssh version
- ssh2python version
- paramiko version
- python version
- scrapli version
- version of any optional extras (paramiko|ssh2-python|textfsm, etc.)

**Additional context**
Add any other context about the problem here.
30 changes: 30 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Description

Please include a summary of the change and, if applicable, which issue this change is associated with. Please also
include relevant motivation and context. List any dependencies that are required for this change.


## Type of change

Please delete options that are not relevant.

- [ ] 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 not work as expected)
- [ ] This change requires a documentation update

# How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also
list any relevant details for your test configuration


# Checklist:

- [ ] My code follows the style guidelines of this project (no GitHub actions compalints! run `make lint` before
committing!)
- [ ] I have commented my code, pydocstyle and darglint are happy, docstrings are in google docstring format, and all
docstrings include a summary, args, returns and raises fields (even if N/A)
- [ ] I have added tests that prove my fix is effective or that my feature works, if adding "functional" tests please
note if there are any considerations for the vrnetlab setup
- [ ] New and existing unit tests pass locally with my changes
29 changes: 29 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Security Policies and Procedures


## Disclosure Policy

Please open an issue to identify any bugs or security vulnerabilities in scrapli. There is a bug report issue template
that you can fill out that will help get things rolling!


## Update Policy

We will do our best to make any necessary updates to keep scrapli secure, if there is a known issue/gap, this
document will outline the issue and affected version(s) of scrapli.


## Security Related Configurations

Scrapli provides telnet connectivity which is of course insecure, so don't use telnet if you are worried about
security issues! Beyond that, scrapli allows for -- and defaults to -- strict SSH host key checking (though this can
be disabled). Strict host key checking can be disabled though, so if that worries you, don't do that! Scrapli does
not store any credential information, however of course username/password/etc. is stored in memory when using
scrapli.

## Known Security Gaps/Issues

At the moment there are no known security gaps/issues. In the future we will try to update this document with any
issues and what version of scrapli and any dependencies are affected, however this will all be best effort, and
there is are no guarantees/assurance that scrapli is secure; though of course effort is invested to try to make it
as secure as possible!
Empty file removed CONTRIBUTING.md
Empty file.

0 comments on commit 95ee04c

Please sign in to comment.