Community Forum
Code Review Question Guide
Ask code review questions that focus on behavior, risk, tests, edge cases and maintainability instead of personal preference. It helps developers ask better questions, preserve useful evidence and keep public examples safe enough to share.
Use this when
- You want another developer to understand the issue without guessing.
- You need to remove secrets and private data before sharing evidence.
- You want the final answer to become a reusable Formalint-style reference.
Practical workflow
| Step | What to include |
|---|---|
| Lead with behavior | Ask whether the change preserves user-visible and API-visible behavior. |
| Point at risk | Security, data loss, auth, performance and migration risk deserve the first review pass. |
| Ask for missing tests | Name the exact edge case that would make you trust the change more. |
| Document the decision | If the review teaches a rule, turn it into a short team note. |
Template
Behavior risk:
Security or data risk:
Tests added:
Edge cases:
Rollback note:Safety checklist
- Remove passwords, tokens, cookies, private keys and connection strings.
- Replace customer records with tiny synthetic examples.
- Keep exact error text, versions, command output and timestamps when safe.
- Say what changed after the fix so the answer helps future readers.
Good forum content is not long by default. It is specific, safe, reproducible and useful after the first reader leaves.
Related Formalint references
Continue with Formalint Developer Forum, Release Checklist For Developers, Dependency Vulnerability Triage Guide.