You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: PRINCIPALS.md
+10-8
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Development, Maintenance and Community Principals for _NetBox Docker_
2
2
3
-
This principals shall guide the development and the maintenance of _NetBox Docker_.
3
+
These principals shall guide the development and the maintenance of _NetBox Docker_.
4
4
5
5
## Basic principals
6
6
@@ -10,7 +10,7 @@ Everyone is asked to respect that.
10
10
This means, that …
11
11
12
12
- … sometimes features are not implemented as fast as one might like -- or not at all.
13
-
- … sometimes nobody is looking at bugs or they are not fixed as fast as one might like -- or not at all.
13
+
- … sometimes nobody is looking at bugs, or they are not fixed as fast as one might like -- or not at all.
14
14
- … sometimes PRs are not reviewed for an extended period.
15
15
16
16
Everyone is welcome to provide improvements and bug fixes to the benefit of everyone else.
@@ -21,12 +21,12 @@ The goal of the _NetBox Docker_ project is to provide a container to run the bas
21
21
The container should feel like a native container -- as if it were provided by NetBox itself:
22
22
23
23
- Configuration via environment variables where feasible.
24
-
- Except: Whenever a `dict` is required as value of a configuration setting,
25
-
then it must not be provided through an environment variable.
24
+
- Except: Whenever a complex type such as a `dict` is required as value of a configuration setting,
25
+
then it shall not be provided through an environment variable.
26
26
- Configuration of secrets via secret files.
27
-
- Log output to standard out (STDOUT/&1) / standard error (STDERR/&2).
27
+
- Log output to standard out (STDOUT/`&1`) / standard error (STDERR/`&2`).
28
28
- Volumes for data and cache directories.
29
-
- Otherwise no mounts shall be necessary.
29
+
- Otherwise, no mounts shall be necessary.
30
30
- Runs a non-root user by default.
31
31
- One process / role for each instance.
32
32
@@ -39,7 +39,7 @@ The container does not bundle any community plugins.
39
39
40
40
## Maintenance Principals
41
41
42
-
The main goals of maintainig_NetBox Docker_ are:
42
+
The main goals of maintaining_NetBox Docker_ are:
43
43
44
44
- Keeping the project at a high quality level.
45
45
- Keeping the maintenance effort minimal.
@@ -51,8 +51,10 @@ The following guidelines help us to achieve these goals:
51
51
- All manual tasks must be documented.
52
52
- All changes are reviewed by at least one maintainer.
53
53
- Changes of maintainers are reviewed by at least one other maintainer.
54
+
(Except if there's only one maintainer left.)
54
55
- The infrastructure beyond what GitHub provides shall be kept to a minimum.
55
-
- On request, every maintainer shall get access to infrastructure that is beyond GitHub (at the time of writing that's _Docker Hub_ and _Quay_ in particular).
56
+
- On request, every maintainer shall get access to infrastructure that is beyond GitHub
57
+
(at the time of writing that's _Docker Hub_ and _Quay_ in particular).
0 commit comments