🛠️ Guide: How to Report Issues & Submit Fixes (PRs)

[rkvishwa]

🛠️ Project Guide: How to Contribute

To keep our development organized, please follow these guidelines when reporting issues or submitting code.

---

1. Choose the Right Template

When you click "New Issue", you will be presented with several templates. Please choose the one that matches your intent:

• 🐛 Bug Report: Use this for broken features or crashes.
• 🚀 Feature Request: Use this for new ideas or functional enhancements.
• 🎨 UI/UX Improvement: Use this for design tweaks, accessibility, or visual bugs.

Don't see a match? If your issue doesn't fit these categories, click "Open a blank issue" and follow our Square Bracket Convention for the title:

• [DOCS] Update the README instructions
• [REFACTOR] Clean up the login logic
• [SECURITY] Patching dependency vulnerabilities

---

2. Using Labels and Numbers

Labels help us prioritize work at a glance.

• Self-Labeling: If you have the permissions, please add the relevant label (e.g., bug, enhancement, design) from the sidebar.
• The #ID: Once your issue is created, note the number (e.g., [Bug] File type detection error after renaming #101). Use this in all future conversations regarding this task.

---

3. Solving an Issue (The #Number Rule)

When you are ready to submit a fix via a Pull Request (PR), you must link it to the issue so it closes automatically.

The "Magic" Commit Message

Use a linking keyword + the issue number in your commit:

git add .
git commit -m "Fix sidebar alignment; closes #101"