Community Forum
Bug Report Template Guide
Use a concise bug report structure for browser, API, database, formatter and deployment problems without leaking sensitive data. 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 |
|---|---|
| Name the impact | Say who is blocked and whether the problem is production, staging, local or documentation only. |
| List exact steps | Write the shortest click path, command sequence or API request flow. |
| Separate expected from actual | This prevents diagnosis from turning into a vague complaint. |
| Attach safe proof | Use redacted logs, screenshots, headers or payloads and keep secrets out. |
Template
Title:
Impact:
Steps to reproduce:
Expected:
Actual:
Logs or screenshots:
Safe sample:
Owner: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 Developer Forum Question, Api Debugging Checklist, Github Pages Deployment Log Guide.