File: contributing.md

package info (click to toggle)
python-scrapli 2023.7.30-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,512 kB
  • sloc: python: 14,451; makefile: 72
file content (17 lines) | stat: -rw-r--r-- 940 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Contributing
============

Thanks for thinking about contributing! 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 a GitHub discussion topic for any potential feature adds/changes to discuss them prior to opening a PR,
  this way everyone has a chance to chime in and make sure we're all on the same page!
- Please open an issue to discuss any bugs/bug fixes prior to opening a PR.
- Once we all have discussed any adds/changes, pull requests are very much welcome and appreciated!
  - All PRs should pass tests/CI linting -- checkout the Makefile for some shortcuts for linting and 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!