So you want to contribute? That makes you a rock star! :)
Please take 5 minutes to read this and familiarise yourself with these guidelines.
If you've not used github before getting started can be a bit daunting, if you want to propose a feature or fix a bug start by Forking that will create a local copy of crassh in your github account. Next create a branch and make your changes in there. Branching not only fits neatly into the github work flow (you'll notice a button appear in github that says "create a pull request for this branch") but it keeps git tidy under the hood. Finally create a pull request (PR). The PR will create an issue for me to review and make it easy to include your suggestions.
If you have a problem with crassh you can create an issue; please ensure that all issues include the IOS version and full description of the hardware that you are running, also the commands that fail.
Crassh is tested against dynamips (GNS3) IOS devices, if your issue cannot be emulated in this way please consider proving me access to your device for testing.
Where possible, please suggest a fix via a PR
If you have an idea to improve crassh, that's great!
- Where possible, please implement new features as a function
- All new functions will require a test ( and shouldn't break existing tests )
- All new functions will require documentation , i.e. comments that work with sphinx-autodoc.
Please ask if you have any problems with these. Before submitting the PR, please also consider if you need to submit a PR. Crassh is a paramiko wrapper for SSH onto Cisco IOS devices, crassh is not a PR to Paramiko but a child module that depends on it. Please consider creating your own child module for your feature that can depend on crassh.
English is my native language but that doesn't mean I'm perfect at it, inspection and suggestions from the grammar police are welcome.