Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Greptile Summary
This PR standardizes virtual environment activation instructions across the project documentation. The changes update three documentation files (AGENTS.md, CLAUDE.md, and CONTRIBUTING.md) to use consistent virtual environment activation commands.
The main changes include:
- AGENTS.md and CLAUDE.md: Changed from
workon onyx &&tosource backend/.venv/bin/activatefor virtual environment activation - CONTRIBUTING.md: Removed a warning note about avoiding virtual environment setup within the onyx directory for IDE compatibility
These changes align the documentation with the project's standard Python venv setup process documented in CONTRIBUTING.md, which creates a virtual environment using python -m venv .venv. The standardization moves away from virtualenvwrapper-specific commands (workon) to standard Python venv activation, making the instructions more universally applicable and consistent with modern Python development practices.
The changes improve developer experience by providing clear, consistent guidance across all documentation files, eliminating confusion about which virtual environment activation method to use.
Confidence score: 4/5
- This PR is safe to merge with low risk of breaking functionality
- Score reflects documentation-only changes that improve consistency but removes potentially useful IDE guidance
- Pay attention to formatting issue in CLAUDE.md where line continuation may need adjustment
3 files reviewed, 1 comment
| - If you run into any missing python dependency errors, try running your command with `source backend/.venv/bin/activate` \ | ||
| to assume the python venv. |
There was a problem hiding this comment.
syntax: Line continuation formatting is incorrect. The backslash should be at the end of line 7 without a space, and line 8 should continue the sentence properly.
There was a problem hiding this comment.
1 issue found across 3 files
Prompt for AI agents (all 1 issues)
Understand the root cause of the following 1 issues and fix them.
<file name="AGENTS.md">
<violation number="1" location="AGENTS.md:7">
Virtualenv activation path is inconsistent with CONTRIBUTING.md; use source .venv/bin/activate to match the documented setup.</violation>
</file>
React with 👍 or 👎 to teach cubic. Mention @cubic-dev-ai to give feedback, ask questions, or re-run the review.
| ## KEY NOTES | ||
|
|
||
| - If you run into any missing python dependency errors, try running your command with `workon onyx &&` in front | ||
| - If you run into any missing python dependency errors, try running your command with `source backend/.venv/bin/activate` \ |
There was a problem hiding this comment.
Virtualenv activation path is inconsistent with CONTRIBUTING.md; use source .venv/bin/activate to match the documented setup.
Prompt for AI agents
Address the following comment on AGENTS.md at line 7:
<comment>Virtualenv activation path is inconsistent with CONTRIBUTING.md; use source .venv/bin/activate to match the documented setup.</comment>
<file context>
@@ -4,7 +4,7 @@ This file provides guidance to Codex when working with code in this repository.
## KEY NOTES
-- If you run into any missing python dependency errors, try running your command with `workon onyx &&` in front
+- If you run into any missing python dependency errors, try running your command with `source backend/.venv/bin/activate` \
to assume the python venv.
- To make tests work, check the `.env` file at the root of the project to find an OpenAI key.
</file context>
| - If you run into any missing python dependency errors, try running your command with `source backend/.venv/bin/activate` \ | |
| - If you run into any missing python dependency errors, try running your command with `source .venv/bin/activate` \ |
Description
^
How Has This Been Tested?
[Describe the tests you ran to verify your changes]
Backporting (check the box to trigger backport action)
Note: You have to check that the action passes, otherwise resolve the conflicts manually and tag the patches.