docs: add CONTRIBUTING_QUICKSTART.md for new developers

[swathiyara9-ai]

Summary

Added a new CONTRIBUTING_QUICKSTART.md guide to help new developers quickly set up the TENET AI project and start contributing. The guide complements the existing CONTRIBUTING.md by providing a streamlined onboarding experience.

Key Changes

• Added CONTRIBUTING_QUICKSTART.md in the repository root.
• Included prerequisites and a quick setup guide.
• Documented local development workflow and service overview.
• Added testing commands and code quality checks.
• Included troubleshooting tips for common setup issues.
• Linked to CONTRIBUTING.md and docs/testing.md for detailed documentation.

---

Related Issue

Fixes #42

---

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• CI/CD Improvement
• Added Tests

---

Screenshots / Logs (Optional)

N/A

---

How Has This Been Tested?

Reviewed the guide against the latest project structure, CONTRIBUTING.md, and docker-compose.yml to ensure setup commands, service information, and documentation links are accurate.

• Unit tests
• Integration tests
• Manual testing

---

Checklist

• My code follows the project's code style
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

---

Additional Notes (Optional)

This PR introduces a documentation-only quick-start guide intended to simplify onboarding for first-time contributors without replacing the existing CONTRIBUTING.md.

---

Summary by cubic

Adds a fast-start guide CONTRIBUTING_QUICKSTART.md to help new developers set up the project and run the full stack in under 10 minutes. Includes prerequisites, a 5-step setup, service URLs with health checks, a first-change walkthrough, test/quality commands (pytest, black, ruff, bandit, coverage target), troubleshooting, Windows tips, and links to CONTRIBUTING.md and docs/testing.md.

^{Written for commit 9d20ccd. Summary will update on new commits.}

Summary by CodeRabbit

• Documentation
  • Added a new contributor quickstart guide for running the full TENET-AI stack locally, including prerequisites and a step-by-step setup workflow.
  • Included “Running Locally” instructions with local service URLs, /health verification, and a way to stop services.
  • Added a “Making Your First Change” walkthrough (edit analyzer heuristics, restart, test via POST /v1/analyze, commit).
  • Documented running unit tests, code quality/coverage checks, and troubleshooting for common local and runtime issues.

[vercel]

@swathiyara9-ai is attempting to deploy a commit to the s3dfx-cyber's projects Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR adds CONTRIBUTING_QUICKSTART.md, a contributor quickstart with prerequisites, local setup, running instructions, a first-change example, test commands, troubleshooting, and follow-up links.

Changes

Contributor Quickstart Guide

Layer / File(s)	Summary
Prerequisites and setup CONTRIBUTING_QUICKSTART.md	Documents required tools, the quick setup workflow, and how to start the local stack.
Running locally CONTRIBUTING_QUICKSTART.md	Lists local service URLs, health-check commands, and stack shutdown steps.
First change and tests CONTRIBUTING_QUICKSTART.md	Shows an analyzer heuristic example, manual API validation, unit test commands, and code quality checks.
Troubleshooting and next steps CONTRIBUTING_QUICKSTART.md	Covers common local issues and links to related contribution resources.

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

Suggested labels: documentation, Easy

Suggested reviewers: S3DFX-CYBER

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Linked Issues check	⚠️ Warning	The guide covers the required sections and objectives for #42, but the added file appears to exceed the under-200-line acceptance criterion.	Trim CONTRIBUTING_QUICKSTART.md to under 200 lines while keeping the required sections, copy-paste commands, and the time-to-first-run note.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Out of Scope Changes check	✅ Passed	The changes stay within documentation scope and align with the quickstart-guide objective.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The title is concise and accurately summarizes the documentation quickstart addition.
Description check	✅ Passed	The description follows the template and includes summary, issue, change type, testing, checklist, and notes.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

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 `@CONTRIBUTING_QUICKSTART.md`:
- Around line 12-17: The quickstart prerequisites are missing Node.js, which
leaves the setup list incomplete. Update the prerequisites section in
CONTRIBUTING_QUICKSTART.md to include Node.js alongside Python, Docker Compose,
and Git, and add the corresponding version check in the setup command block near
the existing python version and docker compose version checks.

🪄 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: f5f03d04-2daf-40e5-a6be-9254438c387f

📥 Commits

Reviewing files that changed from the base of the PR and between 164fd6e and 8f86492.

📒 Files selected for processing (1)

• CONTRIBUTING_QUICKSTART.md

[cubic-dev-ai]

1 issue found across 1 file

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="CONTRIBUTING_QUICKSTART.md">

<violation number="1" location="CONTRIBUTING_QUICKSTART.md:42">
P1: The Windows PowerShell activation command is technically incorrect for Python venv. In PowerShell, the venv activation script is `Activate.ps1`, not `activate` — the latter is a POSIX shell script that either doesn't exist on Windows or, if run, will execute in a sub-process without persisting environment changes in the current PowerShell session. This will silently fail to activate the virtual environment for Windows contributors. Consider using `.venv\Scripts\Activate.ps1` instead, and optionally noting the need to set execution policy (e.g., `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`) for first-time PowerShell users.</violation>
</file>

<sub>Reply with feedback, questions, or to request a fix.

Re-trigger cubic</sub>

[S3DFX-CYBER]

@swathiyara9-ai fix bot comments and this gtg

[swathiyara9-ai]

Hi! @S3DFX-CYBER I've addressed the CodeRabbit and Cubic AI review comments. The remaining Vercel workflow is awaiting maintainer approval. Please let me know if any further changes are needed. Thanks!