Skip to content

Commit 76b990b

Browse files
PromoFauxyubiuser
andcommitted
applying reviewer suggestions
Co-authored-by: yubiuser <yubiuser@users.noreply.github.com> Signed-off-by: Adam Warner <github@promofaux.dev>
1 parent 9885451 commit 76b990b

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The official Pi-hole Docker image. It packages FTL, the core scripts and the web
3434
- Run `bash test/run.sh` before committing.
3535
- Use Unix line endings (LF); shell scripts in this image run under the container's shell, not Windows.
3636
- Code is licensed under the EUPL 1.2; contributions must be compatible.
37-
- Environment variables are the public interface of this image. Document any new or changed variable in the README, and keep backwards compatibility unless a break is explicitly agreed.
37+
- Environment variables are the public interface of this image. Document any new or changed variable with a PR against the [docs repo](https://github.com/pi-hole/docs) (`docs/docker/configuration.md`), not the README; the full env var reference was deliberately moved out of the README once it grew too long. Keep backwards compatibility unless a break is explicitly agreed.
3838
- Stability comes before features; this image runs unattended on many systems.
3939
- The correct project spelling is "Pi-hole" (capital P, lowercase h, hyphen).
4040

@@ -46,7 +46,7 @@ The official Pi-hole Docker image. It packages FTL, the core scripts and the web
4646

4747
## Common pitfalls
4848

49-
- Changing environment variable behaviour without updating the README and tests.
49+
- Changing environment variable behaviour without updating the docs repo and tests.
5050
- Adding packages to the image without considering size and multi-arch availability.
5151
- Forgetting the DCO sign-off on commits.
5252
- Assuming host paths or Docker Desktop specifics; the image must work on plain Linux Docker and compose.

0 commit comments

Comments
 (0)