Skip to content

Contribution Types

This section outlines the different ways you can contribute to the NetBox Toolkit Plugin.

๐Ÿ› Bug Reports & Fixes

Before Submitting Bug Reports:

  • Search existing issues for duplicates
  • Test with the latest version
  • Include NetBox version and plugin version

What to Include in Bug Reports:

  • Clear description of the bug
  • Steps to reproduce the issue
  • Expected vs actual behavior
  • Error messages or logs
  • Network device details if relevant

โœจ Feature Requests & Development

Before Starting Development:

  • Open an issue to discuss major changes
  • Review existing feature requests
  • Consider backward compatibility

Development Guidelines:

  • Use the develop branch for latest features (Development Setup)
  • Follow existing code patterns and architecture
  • Update documentation for user-facing changes
  • Add tests for new functionality

๐Ÿ“š Documentation Improvements

Areas of Focus:

  • Network engineer clarity (avoid programming jargon)
  • Practical examples and use cases
  • Configuration snippets and troubleshooting
  • Cross-linking between related topics

๐Ÿงช Testing Contributions

Testing Priorities:

  • Device connector reliability
  • Permission system functionality
  • Rate limiting behavior
  • API endpoint coverage