Skip to content

docs: add CONTRIBUTING_QUICKSTART.md for new developers#159

Open
arya2807 wants to merge 2 commits into
TENET-DEV-AI:mainfrom
arya2807:feature/contributing-quickstart
Open

docs: add CONTRIBUTING_QUICKSTART.md for new developers#159
arya2807 wants to merge 2 commits into
TENET-DEV-AI:mainfrom
arya2807:feature/contributing-quickstart

Conversation

@arya2807

@arya2807 arya2807 commented Jun 10, 2026

Copy link
Copy Markdown

What this PR adds

This PR adds a CONTRIBUTING_QUICKSTART.md file that helps new developers set up TENET-AI in under 10 minutes.

What's included (step-by-step)

  • Prerequisites - How to check if Git, Docker, PowerShell are installed
  • Step 1: Clone - Exact git commands with verification
  • Step 2: Environment - How to create .env file (handles missing .env.example)
  • Step 3: Start services - Docker compose commands with what to expect
  • Step 4: Access - URLs for API, docs, dashboard with health check
  • Step 5: Stop - How to stop and clean up
  • Running tests - Actual pytest commands
  • Making changes - Hot-reload example
  • Troubleshooting - Common issues and solutions

Why this is better

The previous version just listed steps without commands. This version includes:

  • Actual copy-paste commands
  • Verification steps
  • Error handling
  • Troubleshooting table

Closes

#42

Summary by CodeRabbit

  • Documentation
    • Added a quickstart guide with time-to-first-run information, system prerequisites (Git 2.30+, Docker Desktop 4.20+, PowerShell 7+ for Windows), and initial repository setup instructions.

@vercel

vercel Bot commented Jun 10, 2026

Copy link
Copy Markdown

@arya2807 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

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

This PR introduces the CONTRIBUTING_QUICKSTART.md document, a new quickstart guide for the TENET AI project. The guide outlines prerequisites (Git 2.30+, Docker Desktop 4.20+, PowerShell 7+ for Windows) and provides the initial setup step to clone the repository.

Changes

Quickstart Guide Documentation

Layer / File(s) Summary
Quickstart Guide Content
CONTRIBUTING_QUICKSTART.md
New quickstart guide document with time-to-first-run overview, prerequisites checklist with download and verification links, and initial setup step with repository clone command.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

Poem

🐰 A quickstart guide hops into place,
With prerequisites clear, at a steady pace,
From clone to setup, the path is bright,
New contributors find their way right! 🚀

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description covers summary and key changes but lacks required sections like Related Issue link, Type of Change checkboxes, and testing/checklist sections from the template. Add missing template sections: explicitly link the issue with 'Fixes #42', check the 'Documentation update' checkbox, and complete the checklist confirming code review and testing practices.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add CONTRIBUTING_QUICKSTART.md for new developers' clearly and specifically describes the main change—adding a new quickstart documentation file.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

@cubic-dev-ai cubic-dev-ai 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.

No issues found across 1 file

Re-trigger cubic

@S3DFX-CYBER S3DFX-CYBER requested a review from Preetham404 June 10, 2026 17:48

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This needs to be explained too step by step , not just some shortcut

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I agree that additional step-by-step instructions would make the quickstart guide more helpful for new contributors, especially during the initial setup process.

@arya2807 arya2807 force-pushed the feature/contributing-quickstart branch from e6c2fd0 to 473665c Compare June 10, 2026 18:08

@Preetham404 Preetham404 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you for the contribution. The quickstart guide is a useful addition for new contributors. I agree that adding more detailed step-by-step setup instructions would improve clarity and make onboarding easier. Please consider addressing the review feedback before merging.

@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.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
CONTRIBUTING_QUICKSTART.md (1)

51-57: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Close the Step 1 code fence.

The fenced block starts on Line 51 but never closes, so the rest of the guide will render incorrectly.

♻️ Proposed fix
 git clone https://github.com/TENET-DEV-AI/TENET-AI.git
 cd TENET-AI
+```
🤖 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 `@CONTRIBUTING_QUICKSTART.md` around lines 51 - 57, The markdown code fence
opened before the git commands (the triple backticks preceding "git clone
https://github.com/TENET-DEV-AI/TENET-AI.git" in CONTRIBUTING_QUICKSTART.md is
not closed), so close that fenced block by adding a matching closing triple
backtick after the "cd TENET-AI" line to ensure the rest of the document renders
correctly.
🤖 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.

Outside diff comments:
In `@CONTRIBUTING_QUICKSTART.md`:
- Around line 51-57: The markdown code fence opened before the git commands (the
triple backticks preceding "git clone
https://github.com/TENET-DEV-AI/TENET-AI.git" in CONTRIBUTING_QUICKSTART.md is
not closed), so close that fenced block by adding a matching closing triple
backtick after the "cd TENET-AI" line to ensure the rest of the document renders
correctly.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 7947963a-4b8a-4f54-b8ff-898891a8ab89

📥 Commits

Reviewing files that changed from the base of the PR and between 721686f and d089210.

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

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.

3 participants