Add Commenting Style & Enhance README for Better Developer Experience

[RAJVEER42]

🔀 Pull Request: Commenting + README Improvements

🧠 Summary

This PR improves code readability, developer onboarding, and contribution standards by:

• ✅ Adding structured and meaningful comments to key Flutter screen files

• ✅ Creating a new README.md with:

  • 📁 Folder structure overview

  • 🛠️ Setup & run instructions

  • ✍️ Commenting style guide (with emoji support)

  • 🤝 Contribution guidelines

  • 💡 Dart documentation and linter suggestions

---

🗂️ Files Commented

Thanks to guidance from @Prateek9876, the following files now include /// doc comments and // inline notes:

• main.dart

• login_page.dart

• register_screen.dart

• profile_screen.dart

• issue_selection.dart

• discussion.dart

• admin_dashboard.dart

• feedback.dart

• logo.dart

---

📘 README Highlights

• ✅ Added emoji-based commenting guide

• 📁 Explained folder structure (lib/, lib/screens/, etc.)

• 🚀 Included developer setup and run instructions

• 🧹 Shared clean code tips (linters, dart doc, formatting)

---

📚 Commenting Style

We follow a clean, emoji-supported style to make the code beginner-friendly and easy to scan.

• // — short, inline logic or layout notes
  // 📏 Adds spacing between fields

• /// — documentation for functions, widgets, or classes

  dart
  CopyEdit
  /// Navigates to the specified screen with zoom transition.
  /// [context] - Current widget context.
  /// [screen] - Destination screen to navigate.
  

Emoji Guide:

Emoji | Meaning -- | -- 📝 | Feedback or text input ⭐ | Star rating 📏 | Spacing/Layout ✅ | Checkbox or toggle 📤 | Submit button 🚀 | Important logic 🧾 | Title or label 🔐 | Auth-related

🔀 Pull Request: Commenting + README Improvements

🧠 Summary

This PR improves code readability, developer onboarding, and contribution standards by:

• ✅ Adding structured and meaningful comments to key Flutter screen files

• ✅ Creating a new README.md with:

  • 📁 Folder structure overview

  • 🛠️ Setup & run instructions

  • ✍️ Commenting style guide (with emoji support)

  • 🤝 Contribution guidelines

  • 💡 Dart documentation and linter suggestions

---

🗂️ Files Commented

Thanks to guidance from @Prateek9876, the following files now include /// doc comments and // inline notes:

• main.dart

• login_page.dart

• register_screen.dart

• profile_screen.dart

• issue_selection.dart

• discussion.dart

• admin_dashboard.dart

• feedback.dart

• logo.dart

---

📘 README Highlights

• ✅ Added emoji-based commenting guide

• 📁 Explained folder structure (lib/, lib/screens/, etc.)

• 🚀 Included developer setup and run instructions

• 🧹 Shared clean code tips (linters, dart doc, formatting)

---

📚 Commenting Style

We follow a clean, emoji-supported style to make the code beginner-friendly and easy to scan.

• // — short, inline logic or layout notes
  // 📏 Adds spacing between fields

• /// — documentation for functions, widgets, or classes

  dart
  CopyEdit
  /// Navigates to the specified screen with zoom transition.
  /// [context] - Current widget context.
  /// [screen] - Destination screen to navigate.
  

Emoji Guide:

Emoji | Meaning -- | -- 📝 | Feedback or text input ⭐ | Star rating 📏 | Spacing/Layout ✅ | Checkbox or toggle 📤 | Submit button 🚀 | Important logic 🧾 | Title or label 🔐 | Auth-related