github-personal/firezone
1
0
Fork 0
mirror of https://github.com/outbackdingo/firezone.git synced 2026-01-27 10:18:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): formalize the rule for logging sensitive info (#4663)

Browse Source 
Closes #4662
This commit is contained in:
Reactor Scram
2024-04-17 15:19:29 -05:00
committed by GitHub
parent 1f2821415f
commit 5faf51f890
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/CONTRIBUTING.md
View File

@@ -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