Contributor Quick Checklist

Contributing to CodeNearby

First off, thank you for taking the time to contribute!
We appreciate your support and commitment to making CodeNearby better for developers everywhere.

---

🚀 How You Can Contribute

• Bug Reports: Help us improve by reporting reproducible bugs.
• Feature Requests: Suggest new features to enhance the platform.
• UI Suggestions: Recommend UI/UX improvements for a better experience.
• Performance Issues: Help identify and resolve performance bottlenecks.
• Documentation Feedback: Help keep our docs clear and accurate.
• Pull Requests: Fix a bug, improve docs, refactor code, or add a feature.

---

📂 Issue Templates

When opening a new issue, please select the appropriate template:

Template	Purpose
🐛 Bug Report	Report software defects and glitches.
📚 Docs Feedback	Suggest corrections or improvements to documentation.
🚀 Feature Request	Propose new features or enhancements.
⚡ Performance Issue	Report slowdowns, bottlenecks, or optimization needs.
🎨 UI Suggestion	Share ideas to improve the user interface and experience.

Please provide as much detail as possible so we can address it effectively.

---

📋 Pull Request Process

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature-name).
3. Commit your changes (git commit -m 'Add some feature').
4. Push to your branch (git push origin feature/your-feature-name).
5. Open a Pull Request on the main branch.
6. In the pull request description:
   • Clearly summarize what you changed.
   • Explain why it’s needed.
   • Add screenshots if visual changes are included.

---

🔥 Commit Guidelines

Use clear and structured commit messages:

Type	Usage
feat:	New feature
fix:	Bug fix
docs:	Documentation only changes
style:	Code style changes (formatting, missing semi-colons, etc.)
refactor:	Refactoring code without changing behavior
perf:	Performance improvements
test:	Adding or fixing tests

Example:

feat(auth): add GitHub OAuth login

---

🧹 Code Quality Checklist

• Follow the existing coding style.
• Keep pull requests small and focused.
• Write unit tests when applicable.
• Test thoroughly before submitting.

---

🛡️ Code of Conduct

Please read and follow our Code of Conduct to ensure a welcoming community for everyone.

---

🤝 Thank You

Your contributions make CodeNearby better for developers everywhere.
We’re excited to collaborate with you and build something amazing together.