Skip to content

Contributing Guide

We welcome contributions to the NetBox Toolkit Plugin! Every contribution helps improve the plugin for network engineers and automation teams worldwide.

🚀 Quick Start for Contributors

🎯 Recommended Path: Use the Dev Container for the fastest setup - complete environment in minutes!

Traditional Setup: Start with Development Setup to get your environment ready.

Code Reference Docs: Jump to Code Guide for codebase navigation.

📚 Development Sections

📋 Contribution Types

Learn about the different ways to contribute: bug reports, feature development, documentation improvements, and testing.

🛠️ Development Workflow

Step-by-step guide for setting up your environment, making changes, and submitting contributions.

🏗️ Technical Stack & Architecture

Understanding the project's architecture principles, design patterns, and technical dependencies.

🆘 Getting Help

Resources for issue reporting, community support, and debugging assistance.

🏢 Project Structure

For a deeper understanding of the codebase:

Each section above provides detailed information to help you contribute effectively to the NetBox Toolkit Plugin.