From 5faf51f89006567420b24228e9f0d615ea897ffe Mon Sep 17 00:00:00 2001 From: Reactor Scram Date: Wed, 17 Apr 2024 15:19:29 -0500 Subject: [PATCH] chore(docs): formalize the rule for logging sensitive info (#4663) Closes #4662 --- docs/CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 02ca4d963..02006f80f 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -26,6 +26,7 @@ started. - [Use Detailed Commit Messages](#use-detailed-commit-messages) - [Ensure Static Analysis Checks Pass](#ensure-static-analysis-checks-pass) - [Code of Conduct](CODE_OF_CONDUCT.md) +- [Logging and sensitive info](#logging-and-sensitive-info) - [Asking for Help](#asking-for-help) ## Overview @@ -277,6 +278,11 @@ This should run automatically when you run `git commit`, but in case it doesn't: pre-commit run --all-files ``` +## Logging and sensitive info + +IP addresses and domain names may be logged at the DEBUG level, but not INFO or +any other level that is enabled by default in production builds. + ## Asking For Help If you get stuck, don't hesitate to ask for help on our