Skip to content

1. Conventional commit style (common, and matches typical branch names like fix/..., feature/...)#602

Open
vidyanshshukla26-oss wants to merge 2 commits into
Kuldeeep18:mainfrom
vidyanshshukla26-oss:main
Open

1. Conventional commit style (common, and matches typical branch names like fix/..., feature/...)#602
vidyanshshukla26-oss wants to merge 2 commits into
Kuldeeep18:mainfrom
vidyanshshukla26-oss:main

Conversation

@vidyanshshukla26-oss

@vidyanshshukla26-oss vidyanshshukla26-oss commented Jul 7, 2026

Copy link
Copy Markdown

Pull Request

🔗 Related Issue

Closes #<!-- Issue number -- 467>


📝 Summary of Changes

fix: scope analytics queries to tenant
feat: add real execution for LinkedIn step
docs: update README with contributor workflow
chore: remove leftover Vite scaffold in frontend/src


🏷️ Type of Change

  • 🐛 Bug fix
  • ✨ New feature
  • ♻️ Refactor
  • 📝 Documentation update
  • 🎨 UI / Style change
  • 🔧 Chore

🧪 Testing

Steps to test:

  1. Previewed the rendered README.md on GitHub (or locally via a Markdown previewer) to confirm badges, collapsible

    Details sections, and tables display correctly.

  2. Clicked through all Table of Contents anchor links to confirm they jump to the correct section.

3.Cross-checked the setup commands, .env template, and API endpoint list against the current codebase to confirm nothing is inaccurate or stale.


📸 Screenshots (if applicable)


✅ Checklist

  • No merge conflicts
  • Changes follow the project guidelines
  • Documentation updated (if applicable)
  • Related issue linked
  • Changes tested locally (if applicable)

Summary by CodeRabbit

  • Documentation
    • Reorganized and refreshed the README into a clearer product-style guide with branding, badges, and a table of contents.
    • Updated setup instructions into step-by-step sections, including clearer local configuration guidance and environment variable placeholders.
    • Reworked feature/status information, quick-reference links, API details, caveats, and contributor notes for easier scanning.

Updated README to reflect current branding and features, including new badges and a detailed overview of the platform's capabilities.
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The README.md file was reorganized into a product-doc style layout, adding a branded header, status badges, table of contents, and collapsible setup sections. Content on setup, API surface, testing, workflow, caveats, and contributors was reformatted and updated without changing any exported/public entities.

Changes

README documentation restructure

Layer / File(s) Summary
Header, status, and stack overview
README.md
Adds LeadOrbit branding, status badges, table of contents, a "What Works Today" status table, and rewritten Stack/Repo Layout sections with an expandable "I Want to Change X" map.
Local setup and environment configuration
README.md
Converts Local Setup into collapsible steps, adds a backend/.env template, notes that real OpenRouter/Twilio/Google keys aren't required for most dev work, and reformats migrate/run/serve and background jobs steps.
Frontend, API, testing, and workflow sections
README.md
Reformats Frontend Behavior wording, moves API Surface endpoints into an expandable details block, and updates Testing and Making Changes workflow sections.
Caveats, integration notes, and contributors
README.md
Updates Current Caveats wording, presents Integration Notes as a table, and revises the Contributors section copy.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Related PRs: None identified.

Suggested labels: documentation

Suggested reviewers: None identified.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title describes commit style, not the actual changes in this PR. Use a concise title that names the main change, such as updating LeadOrbit docs and README branding.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Warning

⚠️ This pull request shows signs of AI-generated slop (description_diff_mismatch, ai_padded_prose). It has been flagged by CodeRabbit slop detection and should be reviewed carefully.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 316-319: The README still claims analytics queries are unscoped
across tenants, but that caveat is stale. Update the analytics notes to remove
this warning and reflect that the dashboard queries already filter by
request.user.organization, keeping the remaining utility-endpoint and
auto-advance notes intact.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: fa018952-6522-411b-bb97-2ef1858c1df4

📥 Commits

Reviewing files that changed from the base of the PR and between 4a33158 and 8d8b1c5.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
Comment on lines +316 to 319
- 🔓 **Analytics queries are currently unscoped** across tenants — a real gap worth fixing before production use.
- 🔓 A few utility endpoints are **intentionally permissive** for MVP speed — harden before wider deployment.
- 🚧 `WHATSAPP` / `LINKEDIN` / `MANUAL` steps are visible in the builder but **auto-advance without executing** anything real.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

# Inspect the README section around the cited lines.
if [ -f README.md ]; then
  sed -n '300,330p' README.md | cat -n
fi

# Find analytics/tenant-scoping references in the repo.
rg -n --hidden --glob '!**/node_modules/**' --glob '!**/dist/**' --glob '!**/build/**' \
  -e 'tenant' -e 'scop' -e 'analytics' -e 'tenantId' -e 'organizationId' -e 'workspaceId' \
  .

# Locate likely analytics implementation files.
fd -i 'analytics|tenant|scope' .

Repository: Kuldeeep18/LeadOrbit

Length of output: 16341


🏁 Script executed:

#!/bin/bash
set -euo pipefail

# Read the tenant manager and middleware implementations.
sed -n '1,220p' backend/tenants/models.py | cat -n
printf '\n---\n'
sed -n '1,220p' backend/tenants/middleware.py | cat -n
printf '\n---\n'
# Read the analytics view region.
sed -n '460,540p' backend/campaigns/views.py | cat -n
printf '\n---\n'
# Read the tenant-isolation analytics test.
sed -n '1640,1715p' backend/campaigns/tests.py | cat -n

Repository: Kuldeeep18/LeadOrbit

Length of output: 11314


Remove the stale tenant-scoping caveat. Analytics dashboard queries already filter by request.user.organization, and the tenant-isolation test covers the cross-tenant case.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 316 - 319, The README still claims analytics queries
are unscoped across tenants, but that caveat is stale. Update the analytics
notes to remove this warning and reflect that the dashboard queries already
filter by request.user.organization, keeping the remaining utility-endpoint and
auto-advance notes intact.

@vidyanshshukla26-oss

Copy link
Copy Markdown
Author

Hi @Kuldeeep18

If you are able to check my Readme and able to merge it that will be grateful.

@vidyanshshukla26-oss

Copy link
Copy Markdown
Author

Do review this PR and add valid GSSOC26 labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant