docs: add CONTRIBUTING_QUICKSTART.md for new developers#159
Conversation
|
@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. |
📝 WalkthroughWalkthroughThis 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. ChangesQuickstart Guide Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
This needs to be explained too step by step , not just some shortcut
There was a problem hiding this comment.
I agree that additional step-by-step instructions would make the quickstart guide more helpful for new contributors, especially during the initial setup process.
…nds and actual code snippets closes TENET-DEV-AI#42
e6c2fd0 to
473665c
Compare
Preetham404
left a comment
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 winClose 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
📒 Files selected for processing (1)
CONTRIBUTING_QUICKSTART.md
What this PR adds
This PR adds a
CONTRIBUTING_QUICKSTART.mdfile that helps new developers set up TENET-AI in under 10 minutes.What's included (step-by-step)
.envfile (handles missing.env.example)Why this is better
The previous version just listed steps without commands. This version includes:
Closes
#42
Summary by CodeRabbit