Skip to content

Latest commit

 

History

History
93 lines (70 loc) · 3.89 KB

CONTRIBUTING.md

File metadata and controls

93 lines (70 loc) · 3.89 KB
Raw

Contribution Guidelines

Before opening any ciscoconfparse2 issues or proposing any pull requests, please read this document completely.

To get the greatest chance of helpful responses, please also observe the following.

Contributions

Bug Reports

Please be aware of the following things when filing bug reports:

  1. Avoid raising duplicate issues. Please use the GitHub issue search feature to check whether your bug report or feature request has been discussed in the past. Duplicate bug reports and feature requests are a non-trivial maintenance burden on the resources of the project. If it is clear from your report that you could not find the original, no worries. However, we will usually close duplicate issues.

  2. When filing bug reports about exceptions or tracebacks, please include the complete traceback. Partial tracebacks, or just the exception text, are not helpful. Issues that do not contain complete tracebacks may be closed without warning.

  3. Make sure you provide a suitable amount of information to work with. This means you should provide:

    • Guidance on how to reproduce the issue. Ideally, this should be a small code sample that can be run immediately by the maintainers. Failing that, let us know what you're doing, how often it happens, what environment you're using, etc. Be thorough: it prevents us needing to ask further questions.
    • Tell us what you expected to happen. When we run your example code, what are we expecting to happen? What does "success" look like for your code?
    • Tell us what actually happens. It's not helpful for you to say "it doesn't work" or "it fails". Tell us how it fails: do you get an exception? A hang? How was the actual result different from your expected result?
    • Add the entire text configuration file as rendered by the network device.
    • Tell us what version of ciscoconfparse2 you're using, and how you installed it. Different versions of ciscoconfparse2 behave differently. If possible, you should check the latest ciscoconfparse2 release before filing a new bug.

    If you do not provide sufficient detail, it could take us much longer to fix your problem.

Pull Requests

  1. Please email Mike Pennington before writing a PR. We might not be interested in the feature, or already have plans to fix an issue. Unsolicited PRs may be closed.

  2. PRs must include tests for the functionality being added, or bugs being fixed. Needless to say, your PR itself must not fail existing tests.

Github Issues

  1. CiscoConfParse Github issues are automatically watched for inactivity. Upon detecting stale or inactive issues, they will be automatically locked by a Github Workflow job.

  2. Once locked, no further comments can be added. Locked issues may be unlocked by CiscoConfParse admins solely at their discretion.

Usage Questions

The GitHub issue tracker is for bug reports and feature requests. Please do not use it to ask usage questions about how to use ciscoconfparse2 or how to fix your scripts. Stack Overflow or Reddit r/networking are good examples of places to ask questions. If you ask on Stack Overflow, please make sure that your question is tagged with the ciscoconfparse tag.

Anti-social behavior

Harrassment (in any form, or for any reason), intimidation, trolling, excessive drama, insults, rudeness, stalking, libel, or other abusive behaviors are not welcome for any reason.

Content policy

The project maintainers may edit, close, or delete content at their own discretion.