Merge pull request #1 from Onemind-Services-LLC/dev

Initial Project Setup with Required Files

.dockerignore

@@ -0,0 +1,67 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.pyc
+*$py.class
+*.so
+
+# Translations
+*.mo
+*.pot
+
+# Django
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask
+instance/
+.webassets-cache
+
+# Scrapy
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Environments
+.venv
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# Cython debug symbols
+cython_debug/
+
+# JetBrains IDEs
+.idea/
+
+# VS Code
+.vscode/
+
+# Temporary files
+*.tmp
+tmp/
+
+# coverage
+coverage/
+
+# ruff
+.ruff_cache/

.github/ISSUE_TEMPLATE/1-bug-report.yml

@@ -0,0 +1,58 @@
+---
+name: 🐞 Bug Report
+description: Report a Reproducible Bug in the Current Release of this NetBox Plugin
+labels: [ "type: bug" ]
+assignees: "kprince28"
+body:
+  - type: markdown
+    attributes:
+      value: >
+        **Note:** This form is exclusively for reporting _reproducible bugs_ in the current NetBox plugin installation.
+
+  - type: input
+    attributes:
+      label: NetBox Version
+      description: Indicate the version of NetBox you are currently running.
+      placeholder: v3.5.4
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: NetBox Plugin Version
+      description: Please specify the version of the NetBox plugin you are currently using.
+      placeholder: v1.3.0
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Steps to Reproduce
+      description: >
+        When submitting a bug report for the NetBox plugin, it's essential to provide comprehensive step-by-step instructions for reproducing the issue on a clean, empty NetBox installation. These instructions should be clear enough for someone else to follow effortlessly and must encompass the creation of any necessary objects, configuration changes, and a complete accounting of the actions being taken. Remember, the goal is to ensure that the problem can be replicated precisely using the current stable release of the NetBox plugin.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: Describe what you expected to happen.
+      placeholder: A new widget should have been created with the specified attributes.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Observed Behavior
+      description: Describe what actually happened.
+      placeholder: A TypeError exception was raised
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: Resolve By
+      description: Please specify a date by which you expect this change to be implemented.
+      placeholder: '2021-01-01'
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/2-feature-request.yml

@@ -0,0 +1,65 @@
+---
+name: ✨ Feature Request
+description: Propose a new feature or enhancement
+labels: [ "type: feature" ]
+assignees: "kprince28"
+body:
+  - type: markdown
+    attributes:
+      value: >
+        **NOTE:** This form is exclusively for submitting well-considered proposals to expand or refine
+        NetBox Plugin's functionality. If you're grappling with a problem or still refining your feature idea,
+        please initiate a discussion instead.
+
+  - type: input
+    attributes:
+      label: Current NetBox Version
+      description: What version of NetBox are you currently running?
+      placeholder: v3.5.4
+    validations:
+      required: true
+
+  - type: dropdown
+    attributes:
+      label: Feature Type
+      options:
+        - New Model for Plugin
+        - Modification to Existing Model
+        - Addition of a Function
+        - Removal of a Function
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Proposed Functionality
+      description: >
+        Provide a comprehensive description of the new feature or behavior you are suggesting. Include specific changes
+        to workflows, data models, and dependencies. The more detailed your proposal, the higher the chance it will be discussed.
+        Feature requests without a clear implementation plan may be declined.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Use Case
+      description: >
+        Explain how implementing this functionality would benefit NetBox users, particularly within this plugin's context.
+        What problem does it address?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: External Dependencies
+      description: >
+        Enumerate any new external libraries or services that this feature would necessitate.
+        For example, does it require installing a new Python package? (Not all new features introduce dependencies.)
+
+  - type: input
+    attributes:
+      label: Resolve By
+      description: Please specify a date by which you expect this change to be implemented.
+      placeholder: '2021-01-01'
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/3-documentation-change.yml

@@ -0,0 +1,45 @@
+---
+name: 📖 Documentation Enhancement
+description: Suggest an enhancement, addition, or modification to the NetBox plugin documentation.
+labels: ["type: docs"]
+assignees: "kprince28"
+body:
+  - type: dropdown
+    attributes:
+      label: Change Type
+      description: Specify the nature of your documentation change.
+      options:
+        - Addition
+        - Correction
+        - Removal
+        - Cleanup (formatting, typos, etc.)
+    validations:
+      required: true
+
+  - type: dropdown
+    attributes:
+      label: Documentation Section
+      description: Indicate the section of the documentation that this change primarily affects.
+      options:
+        - Installation Instructions
+        - Configuration Parameters
+        - Functionality/Features
+        - Administration/Development
+        - Other
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Proposed Changes
+      description: Please describe the proposed changes and explain their significance or necessity.
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: Resolve By
+      description: Please specify a date by which you expect this change to be implemented.
+      placeholder: '2021-01-01'
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/4-housekeeping.yml

@@ -0,0 +1,25 @@
+---
+name: 🏡 Housekeeping
+description: A codebase enhancement (for developers' use only)
+labels: ["type: maintenance"]
+assignees: "kprince28"
+body:
+  - type: markdown
+    attributes:
+      value: >
+        **Important Note:** This template is intended for use by maintainers exclusively. Please refrain from submitting an issue using this template unless you have been specifically requested to do so.
+
+  - type: textarea
+    attributes:
+      label: Proposed Changes
+      description: >
+        Please provide a detailed description of the new feature or behavior you are proposing. Include any specific modifications to workflows, data models, or the user interface.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Justification
+      description: Please offer a rationale for the proposed changes.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/5-deprecation.yml

@@ -0,0 +1,34 @@
+---
+name: ⚠️ Deprecation Notice
+description: A deprecation notice for outdated features or behaviors
+labels: ["type: deprecated"]
+assignees: "kprince28"
+body:
+  - type: markdown
+    attributes:
+      value: >
+        **Important Note:** This template is intended to inform users and developers about the deprecation of certain features or behaviors in the project. If you have questions or need assistance with the transition, please comment on this issue.
+
+  - type: textarea
+    attributes:
+      label: Deprecated Feature or Behavior
+      description: >
+        Please specify the feature or behavior that is being deprecated. Include relevant details such as the file, function, or component name.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Deprecation Details
+      description: >
+        Provide information about why this feature or behavior is being deprecated. Explain any alternatives or recommended actions for users or developers to take.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Timeline for Deprecation
+      description: >
+        Outline the timeline for the deprecation process, including any milestones, dates, or versions when the feature or behavior will be officially deprecated and removed.
+    validations:
+      required: true