Skip to content

CONTRIBUTING.md: Recommend local conda environments#1085

Merged
rgsl888prabhu merged 2 commits intomainfrom
mlubin-patch-1
Apr 9, 2026
Merged

CONTRIBUTING.md: Recommend local conda environments#1085
rgsl888prabhu merged 2 commits intomainfrom
mlubin-patch-1

Conversation

@mlubin
Copy link
Copy Markdown
Contributor

@mlubin mlubin commented Apr 9, 2026

Using a global conda environment is error prone because ./build.sh modifies it. We should recommend a local environment instead.

@mlubin mlubin requested a review from a team as a code owner April 9, 2026 15:45
@mlubin mlubin requested a review from tmckayus April 9, 2026 15:45
@mlubin mlubin added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change labels Apr 9, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 9, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 08ae5c0a-e0e6-4720-a1f4-955da58bec76

📥 Commits

Reviewing files that changed from the base of the PR and between 48cf505 and b1577e1.

📒 Files selected for processing (1)
  • .gitignore
✅ Files skipped from review due to trivial changes (1)
  • .gitignore

📝 Walkthrough

Walkthrough

Updated CONTRIBUTING.md to switch conda commands from a named environment (cuopt_dev) to a path-based environment (./.cuopt_env). Added .cuopt_env to .gitignore.

Changes

Cohort / File(s) Summary
Contributing doc
CONTRIBUTING.md
Replaced conda environment creation and activation examples to use a path-based environment (conda env create -p ./.cuopt_env, conda activate ./.cuopt_env) instead of the named environment cuopt_dev.
Git ignore
.gitignore
Added .cuopt_env to ignore patterns to exclude the path-based Conda environment directory.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main change: updating CONTRIBUTING.md to recommend local conda environments instead of global ones, matching the core objective of the PR.
Description check ✅ Passed The description is directly related to the changeset, explaining the rationale for recommending local conda environments and how it prevents issues with the build script.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch mlubin-patch-1

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

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

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 the current code and only fix it if needed.

Inline comments:
In `@CONTRIBUTING.md`:
- Around line 139-141: Add an entry to .gitignore to exclude the path-based
conda environment named ".cuopt_env" referenced in CONTRIBUTING.md; update the
repository's .gitignore by adding a line for ".cuopt_env/" (or a broader pattern
like ".*env/") so the directory created by running the conda commands (conda env
create -p ./.cuopt_env ...) will not be committed to git, then commit the
updated .gitignore.
🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 2903c4cc-8c66-4748-8643-4efcfa9f9848

📥 Commits

Reviewing files that changed from the base of the PR and between 378add0 and 48cf505.

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

Comment thread CONTRIBUTING.md
@rgsl888prabhu rgsl888prabhu self-requested a review April 9, 2026 15:50
Address coderabbitai comment
@rgsl888prabhu
Copy link
Copy Markdown
Collaborator

I have created a PR to address wheel size failure #1087

@rgsl888prabhu rgsl888prabhu merged commit ce83522 into main Apr 9, 2026
67 of 73 checks passed
@mlubin mlubin deleted the mlubin-patch-1 branch April 9, 2026 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants