Skip to content

Commit 0082261

Browse files
committed
Fix typos
1 parent 052b17d commit 0082261

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

PRINCIPALS.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Development, Maintenance and Community Principals for _NetBox Docker_
22

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_.
44

55
## Basic principals
66

@@ -10,7 +10,7 @@ Everyone is asked to respect that.
1010
This means, that …
1111

1212
- … 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.
1414
- … sometimes PRs are not reviewed for an extended period.
1515

1616
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
2121
The container should feel like a native container -- as if it were provided by NetBox itself:
2222

2323
- 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.
2626
- 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`).
2828
- Volumes for data and cache directories.
29-
- Otherwise no mounts shall be necessary.
29+
- Otherwise, no mounts shall be necessary.
3030
- Runs a non-root user by default.
3131
- One process / role for each instance.
3232

@@ -39,7 +39,7 @@ The container does not bundle any community plugins.
3939

4040
## Maintenance Principals
4141

42-
The main goals of maintainig _NetBox Docker_ are:
42+
The main goals of maintaining _NetBox Docker_ are:
4343

4444
- Keeping the project at a high quality level.
4545
- Keeping the maintenance effort minimal.
@@ -51,8 +51,10 @@ The following guidelines help us to achieve these goals:
5151
- All manual tasks must be documented.
5252
- All changes are reviewed by at least one maintainer.
5353
- Changes of maintainers are reviewed by at least one other maintainer.
54+
(Except if there's only one maintainer left.)
5455
- 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).
5658

5759
## Community Principals
5860

0 commit comments

Comments
 (0)