|
| 1 | +# Contribution Guidelines |
| 2 | + |
| 3 | +Before opening any [ciscoconfparse][1] issues or proposing any pull |
| 4 | +requests, please read this document completely. |
| 5 | + |
| 6 | +To get the greatest chance of helpful responses, please also observe the |
| 7 | +following. |
| 8 | + |
| 9 | +## Contributions |
| 10 | + |
| 11 | +### Bug Reports |
| 12 | + |
| 13 | +Please be aware of the following things when filing bug reports: |
| 14 | + |
| 15 | +1. Avoid raising duplicate issues. *Please* use the [GitHub issue search][3] |
| 16 | + feature to check whether your bug report or feature request has been |
| 17 | + discussed in the past. Duplicate bug reports and feature requests are a |
| 18 | + non-trivial maintenance burden on the resources of the project. If it is |
| 19 | + clear from your report that you could not find the original, no worries. |
| 20 | + However, we will usually close duplicate issues. |
| 21 | +2. When filing bug reports about exceptions or tracebacks, please include the |
| 22 | + *complete* traceback. Partial tracebacks, or just the exception text, are |
| 23 | + not helpful. Issues that do not contain complete tracebacks may be closed |
| 24 | + without warning. |
| 25 | +3. Make sure you provide a suitable amount of information to work with. This |
| 26 | + means you should provide: |
| 27 | + |
| 28 | + - Guidance on **how to reproduce the issue**. Ideally, this should be a |
| 29 | + *small* code sample that can be run immediately by the maintainers. |
| 30 | + Failing that, let us know what you're doing, how often it happens, what |
| 31 | + environment you're using, etc. Be thorough: it prevents us needing to ask |
| 32 | + further questions. |
| 33 | + - Tell us **what you expected to happen**. When we run your example code, |
| 34 | + what are we expecting to happen? What does "success" look like for your |
| 35 | + code? |
| 36 | + - Tell us **what actually happens**. It's not helpful for you to say "it |
| 37 | + doesn't work" or "it fails". Tell us *how* it fails: do you get an |
| 38 | + exception? A hang? How was the actual result different from your expected |
| 39 | + result? |
| 40 | + - Add the entire text configuration file as rendered by the network device. |
| 41 | + - Tell us **what version of [ciscoconfparse][1] you're using**, and |
| 42 | + **how you installed it**. Different versions of [ciscoconfparse][1] behave |
| 43 | + differently. If possible, you should check the latest ciscoconfparse |
| 44 | + release before filing a new bug. |
| 45 | + |
| 46 | + If you do not provide sufficient detail, it could take us much longer to |
| 47 | + fix your problem. |
| 48 | + |
| 49 | + |
| 50 | +### Pull Requests |
| 51 | + |
| 52 | +1. Please email Mike Pennington before writing a PR. We might not be |
| 53 | + interested in the feature, or already have plans to fix an issue. |
| 54 | + Unsolicited PRs may be closed. |
| 55 | + |
| 56 | +2. PRs must include tests for the functionality being added, or bugs being |
| 57 | + fixed. Needless to say, your PR itself must not fail existing tests. |
| 58 | + |
| 59 | +### Github Issues |
| 60 | + |
| 61 | +1. CiscoConfParse Github issues are automatically watched for inactivity. |
| 62 | + Upon detecting stale or inactive issues, they will be automatically locked |
| 63 | + by a Github Workflow job. |
| 64 | + |
| 65 | +2. Once locked, no further comments can be added. Locked issues may be |
| 66 | + unlocked by CiscoConfParse admins solely at their discretion. |
| 67 | + |
| 68 | +## Usage Questions |
| 69 | + |
| 70 | +The [GitHub issue tracker][3] is for *bug reports* and *feature requests*. |
| 71 | +Please do not use it to ask usage questions about how to use |
| 72 | +[ciscoconfparse][1] or how to fix your scripts. [Stack Overflow][4] or |
| 73 | +[Reddit r/networking][5] are good examples of places to ask questions. If |
| 74 | +you ask on [Stack Overflow][4], please make sure that your question is |
| 75 | +tagged with the [ciscoconfparse tag][4]. |
| 76 | + |
| 77 | +## Anti-social behavior |
| 78 | + |
| 79 | + Harrassment (in any form, or for any reason), intimidation, trolling, |
| 80 | + excessive drama, insults, rudeness, stalking, libel, or other abusive |
| 81 | + behaviors are not welcome for any reason. |
| 82 | + |
| 83 | +## Content policy |
| 84 | + |
| 85 | + The project maintainers may edit, close, or delete content at their own |
| 86 | + discretion. |
| 87 | + |
| 88 | + |
| 89 | + [1]: https://github.com/mpenning/ciscoconfparse |
| 90 | + [2]: http://127.0.0.1/ |
| 91 | + [3]: https://github.com/mpenning/ciscoconfparse/issues |
| 92 | + [4]: https://stackoverflow.com/questions/ask?title=How%20do%20I&tags=ciscoconfparse+python |
| 93 | + [5]: https://reddit.com/r/networking |
0 commit comments