Skip to content

Commit d96a6a9

Browse files
jeremystretchjeremystretch
committed
Add license, docs skeleton, and GitHub issue templates
1 parent f2347f6 commit d96a6a9

File tree

8 files changed

+295
-0
lines changed

8 files changed

+295
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yaml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: 🐛 Bug Report
3+
description: Report a reproducible bug in the current stable release
4+
labels: ["bug"]
5+
body:
6+
- type: input
7+
attributes:
8+
label: Plugin Version
9+
description: What version of the plugin are you currently running?
10+
validations:
11+
required: true
12+
- type: input
13+
attributes:
14+
label: NetBox Version
15+
description: What version of NetBox are you currently running?
16+
validations:
17+
required: true
18+
- type: input
19+
attributes:
20+
label: Python Version
21+
description: What version of Python are you currently running?
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Steps to Reproduce
27+
description: >
28+
Describe in detail the exact steps that someone else can take to reproduce
29+
this bug. A numbered list of discrete steps is strongly preferred. Remember
30+
to capture the creation of any objects which must exist to reproduce the
31+
behavior.
32+
placeholder: |
33+
1. Click on "create widget"
34+
2. Set foo to 12 and bar to G
35+
3. Click the "create" button
36+
validations:
37+
required: true
38+
- type: textarea
39+
attributes:
40+
label: Expected Behavior
41+
description: What did you expect to happen?
42+
placeholder: A new widget should have been created with the specified attributes
43+
validations:
44+
required: true
45+
- type: textarea
46+
attributes:
47+
label: Observed Behavior
48+
description: What happened instead?
49+
placeholder: A TypeError exception was raised
50+
validations:
51+
required: true

‎.github/ISSUE_TEMPLATE/documentation_change.yaml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: 📖 Documentation Change
3+
description: Suggest an addition or modification to the plugin's documentation
4+
labels: ["documentation"]
5+
body:
6+
- type: dropdown
7+
attributes:
8+
label: Change Type
9+
description: What type of change are you proposing?
10+
options:
11+
- Addition
12+
- Correction
13+
- Removal
14+
- Cleanup (formatting, typos, etc.)
15+
- Other
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Proposed Changes
21+
description: Describe the proposed changes and why they are necessary.
22+
validations:
23+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yaml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: ✨ Feature Request
3+
description: Propose a new NetBox feature or enhancement
4+
labels: ["feature"]
5+
body:
6+
- type: input
7+
attributes:
8+
label: Plugin Version
9+
description: What version of the plugin are you currently running?
10+
validations:
11+
required: true
12+
- type: textarea
13+
attributes:
14+
label: Proposed functionality
15+
description: >
16+
Describe in detail the new feature or behavior you are proposing. Include any specific changes
17+
to work flows, data models, and/or the user interface. The more detail you provide here, the
18+
greater chance your proposal has of being discussed.
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Use case
24+
description: >
25+
Explain how adding this functionality would benefit users. What need does it address?
26+
validations:
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: External dependencies
31+
description: >
32+
List any new dependencies on external libraries or services that this new feature would
33+
introduce. For example, does the proposal require the installation of a new Python package?

‎LICENSE.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
# PolyForm Shield License 1.0.0
2+
3+
<https://polyformproject.org/licenses/shield/1.0.0>
4+
5+
## Acceptance
6+
7+
In order to get any license under these terms, you must agree
8+
to them as both strict obligations and conditions to all
9+
your licenses.
10+
11+
## Copyright License
12+
13+
The licensor grants you a copyright license for the
14+
software to do everything you might do with the software
15+
that would otherwise infringe the licensor's copyright
16+
in it for any permitted purpose. However, you may
17+
only distribute the software according to [Distribution
18+
License](#distribution-license) and make changes or new works
19+
based on the software according to [Changes and New Works
20+
License](#changes-and-new-works-license).
21+
22+
## Distribution License
23+
24+
The licensor grants you an additional copyright license
25+
to distribute copies of the software. Your license
26+
to distribute covers distributing the software with
27+
changes and new works permitted by [Changes and New Works
28+
License](#changes-and-new-works-license).
29+
30+
## Notices
31+
32+
You must ensure that anyone who gets a copy of any part of
33+
the software from you also gets a copy of these terms or the
34+
URL for them above, as well as copies of any plain-text lines
35+
beginning with `Required Notice:` that the licensor provided
36+
with the software. For example:
37+
38+
> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
39+
40+
## Changes and New Works License
41+
42+
The licensor grants you an additional copyright license to
43+
make changes and new works based on the software for any
44+
permitted purpose.
45+
46+
## Patent License
47+
48+
The licensor grants you a patent license for the software that
49+
covers patent claims the licensor can license, or becomes able
50+
to license, that you would infringe by using the software.
51+
52+
## Noncompete
53+
54+
Any purpose is a permitted purpose, except for providing any
55+
product that competes with the software or any product the
56+
licensor or any of its affiliates provides using the software.
57+
58+
## Competition
59+
60+
Goods and services compete even when they provide functionality
61+
through different kinds of interfaces or for different technical
62+
platforms. Applications can compete with services, libraries
63+
with plugins, frameworks with development tools, and so on,
64+
even if they're written in different programming languages
65+
or for different computer architectures. Goods and services
66+
compete even when provided free of charge. If you market a
67+
product as a practical substitute for the software or another
68+
product, it definitely competes.
69+
70+
## New Products
71+
72+
If you are using the software to provide a product that does
73+
not compete, but the licensor or any of its affiliates brings
74+
your product into competition by providing a new version of
75+
the software or another product using the software, you may
76+
continue using versions of the software available under these
77+
terms beforehand to provide your competing product, but not
78+
any later versions.
79+
80+
## Discontinued Products
81+
82+
You may begin using the software to compete with a product
83+
or service that the licensor or any of its affiliates has
84+
stopped providing, unless the licensor includes a plain-text
85+
line beginning with `Licensor Line of Business:` with the
86+
software that mentions that line of business. For example:
87+
88+
> Licensor Line of Business: YoyodyneCMS Content Management
89+
System (http://example.com/cms)
90+
91+
## Sales of Business
92+
93+
If the licensor or any of its affiliates sells a line of
94+
business developing the software or using the software
95+
to provide a product, the buyer can also enforce
96+
[Noncompete](#noncompete) for that product.
97+
98+
## Fair Use
99+
100+
You may have "fair use" rights for the software under the
101+
law. These terms do not limit them.
102+
103+
## No Other Rights
104+
105+
These terms do not allow you to sublicense or transfer any of
106+
your licenses to anyone else, or prevent the licensor from
107+
granting licenses to anyone else. These terms do not imply
108+
any other licenses.
109+
110+
## Patent Defense
111+
112+
If you make any written claim that the software infringes or
113+
contributes to infringement of any patent, your patent license
114+
for the software granted under these terms ends immediately. If
115+
your company makes such a claim, your patent license ends
116+
immediately for work on behalf of your company.
117+
118+
## Violations
119+
120+
The first time you are notified in writing that you have
121+
violated any of these terms, or done anything with the software
122+
not covered by your licenses, your licenses can nonetheless
123+
continue if you come into full compliance with these terms,
124+
and take practical steps to correct past violations, within
125+
32 days of receiving notice. Otherwise, all your licenses
126+
end immediately.
127+
128+
## No Liability
129+
130+
***As far as the law allows, the software comes as is, without
131+
any warranty or condition, and the licensor will not be liable
132+
to you for any damages arising out of these terms or the use
133+
or nature of the software, under any kind of legal claim.***
134+
135+
## Definitions
136+
137+
The **licensor** is the individual or entity offering these
138+
terms, and the **software** is the software the licensor makes
139+
available under these terms.
140+
141+
A **product** can be a good or service, or a combination
142+
of them.
143+
144+
**You** refers to the individual or entity agreeing to these
145+
terms.
146+
147+
**Your company** is any legal entity, sole proprietorship,
148+
or other kind of organization that you work for, plus all
149+
its affiliates.
150+
151+
**Affiliates** means the other organizations than an
152+
organization has control over, is under the control of, or is
153+
under common control with.
154+
155+
**Control** means ownership of substantially all the assets of
156+
an entity, or the power to direct its management and policies
157+
by vote, contract, or otherwise. Control can be direct or
158+
indirect.
159+
160+
**Your licenses** are all the licenses granted to you for the
161+
software under these terms.
162+
163+
**Use** means anything you do with the software requiring one
164+
of your licenses.

‎NOTICE.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Required Notice: Copyright 2024 NetBox Labs, Inc.
2+
Required Notice: https://netboxlabs.com

‎docs/changelog.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Change Log
2+
3+
## FUTURE
4+
5+
## v0.2.0
6+
7+
* Initial private release

‎docs/index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# NetBox Branching
2+
3+
This plugin adds branching functionality to NetBox.
4+
5+
## Features
6+
7+
## Getting Started
8+

‎mkdocs.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
site_name: NetBox Branching
2+
repo_name: netboxlabs/nbl-netbox-branching
3+
repo_url: https://github.com/netboxlabs/nbl-netbox-branching
4+
theme:
5+
name: material
6+
icon:
7+
repo: fontawesome/brands/github

0 commit comments

Comments
 (0)