Issue Templates

CodeNearby uses structured issue templates to streamline bug reports, feature requests, UI suggestions, documentation updates, and performance feedback. Each template helps contributors communicate clearly and maintain consistency across the project.

---

📌 Available Issue Templates

1. Bug Report (bug_report.md)

Use this to report unexpected behavior or errors.

Fields:

• What’s the issue?
• Steps to reproduce
• Expected behavior
• Environment (OS, Node, browser)
• Additional info (logs, screenshots)

Title Format: [BUG] <brief description>

Labels: bug

---

2. Docs Feedback (docs-feedback.md)

For unclear, outdated, or missing documentation.

Fields:

• What needs improvement?
• Suggested fix or better explanation
• Link to page or file

Title Format: [Docs] <short description>

Labels: documentation

---

3. Feature Request (feature_request.md)

To suggest a new feature or enhancement.

Fields:

• Description of the feature
• Why it's needed
• Optional references or inspiration

Title Format: [Feature] <short description>

Labels: enhancement

---

4. Performance Issue (performance-issue.md)

To report slowness or performance degradation.

Fields:

• Description of the issue
• Steps or views where it occurs
• Optional metrics or logs (e.g., Lighthouse, console)

Title Format: [Perf] <short description>

Labels: performance

---

5. UI Suggestion (ui-suggestion.md)

To recommend UI/UX improvements.

Fields:

• UI suggestion
• Problem with the current version (optional)
• Mockup or reference (optional)

Title Format: [UI] <suggestion>

Labels: design

---

Guidelines

• Use the correct template that best fits your issue type.
• Be as specific as possible.
• If multiple concerns are unrelated, open separate issues.

You can access these templates directly via the New Issue button on GitHub. Each one is designed to help contributors provide enough context for effective triaging and resolution.