Skip to content

Pull Request Template

Subhadip Saha edited this page May 16, 2025 · 2 revisions

This guide explains the standard structure and expectations for submitting a Pull Request (PR) to the CodeNearby repository. Following this ensures high-quality contributions, better collaboration, and easier reviews.


PR Structure

Each PR should follow this template format:

Description

Provide a brief overview of what this PR does and why it is necessary.

## 📄 Description
<!-- Briefly explain what this PR does -->

Related Issues

Link the issue(s) this PR addresses using keywords like Closes, Fixes, or Resolves.

## 🔗 Related Issue(s)
<!-- Mention the issue(s) this PR addresses (ex: Closes #123) -->

Changes Made

List the notable changes introduced in this PR.

## 🛠️ Changes Made
- Added AI-Connect intelligent search
- Improved developer card layout
- Refactored `/api/friends` logic

Testing Details

Ensure the contribution has been properly tested. Use checkboxes:

## 🧪 Testing Details
- [ ] Ran `npm run dev` without errors
- [ ] Manual tests completed (ex: tested feature locally)
- [ ] New/updated unit tests (if applicable)

Screenshots

If applicable, include before/after UI changes to help reviewers understand visual impact.

## 📸 Screenshots (if UI changes)
<!-- Add screenshots or gifs -->

Reviewer Notes

Call out anything reviewers need to pay attention to or special test cases.

## 📝 Notes for Reviewers
<!-- Any special things reviewers should know? -->

PR Checklist

Before submitting a PR, ensure the following:

- [ ] My code follows the project’s style guidelines.
- [ ] I have performed a self-review of my code.
- [ ] I have commented my code where necessary.
- [ ] I have updated documentation where necessary.
- [ ] This PR is ready for a detailed review.

Final Note

Pull requests should be clear, tested, and focused. Avoid mixing unrelated changes. If you're unsure about your approach, feel free to open a Draft PR or Discussion first.

Clone this wiki locally