Updated Contributing guidelines

[ParticularlyPythonicBS]

Summary by CodeRabbit

• Documentation
  • Completely revised CONTRIBUTING guide with expanded sections on development setup, testing infrastructure, and code quality standards.
  • Updated development requirements: Python 3.12+, uv, and pre-commit tools.
  • Added detailed pull request workflow guidance and Conventional Commits conventions.
  • New Code Style Guidelines including type hints and Google-style docstrings.

[coderabbitai]

Warning

Rate limit exceeded

@ParticularlyPythonicBS has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 14 minutes and 41 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 14 minutes and 41 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 0f7ec782-1089-4710-97d4-bc8af56d8297

📥 Commits

Reviewing files that changed from the base of the PR and between 50d4b5f and d45a736.

📒 Files selected for processing (1)

• CONTRIBUTING.md

Walkthrough

CONTRIBUTING.md has been comprehensively rewritten to replace basic contribution guidance with structured sections covering development setup (Python 3.12+, uv, pre-commit), testing infrastructure, code quality tools, pull request workflows, conventional commits, and code style guidelines.

Changes

Cohort / File(s)	Summary
Documentation Update CONTRIBUTING.md	Complete restructuring of contributing guide with expanded sections on development environment setup, testing procedures with pytest, code quality tools (mypy, ruff), pull request workflow, conventional commits format, and code style guidelines including type hints and Google-style docstrings.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Updated Contributing guidelines' directly and clearly describes the main change—a comprehensive update to the CONTRIBUTING.md document with reorganized sections and modernized guidance.
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 contributor_file_update

---

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

[coderabbitai]

Actionable comments posted: 4

🤖 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 26-43: The "Setting Up Your Development Environment" section
contains markdownlint MD022/MD031 spacing violations around headings and fenced
code blocks; fix it by ensuring there is a blank line above and below the "###
Setting Up Your Development Environment" heading and every fenced code block
(the three bash blocks containing "git clone...", "uv sync --all-extras --dev",
and "uv run pre-commit install") so that each heading and triple-backtick code
fence is separated by a blank line from surrounding text; update those locations
accordingly to satisfy MD022/MD031.
- Line 107: Replace the incorrect noun "advice" with the verb "advise" in the
sentence that reads "We advice following the [Conventional Commits]..." so it
becomes "We advise following the [Conventional
Commits](https://www.conventionalcommits.org/) style." This fixes the
grammatical error in the CONTRIBUTING.md content string.
- Line 103: Update the "Open a Pull Request" guidance that currently instructs
contributors to target the `main` branch: change the text to instruct opening
PRs against the `unstable` branch (or explain when to use `main` vs `unstable`),
and ensure the sentence referencing `main` is replaced with `unstable` and any
related automation notes are adjusted accordingly in the "Open a Pull Request"
section (the line containing "Open a Pull Request: Submit your PR against the
`main` branch").
- Around line 50-52: Add a short explicit note under the "Solvers" section
stating that NEOS is currently unsupported; mention that while HiGHS (highspy)
is the supported solver, NEOS-related config paths are still present but will
raise NotImplementedError if used. Place a single-sentence clarification
directly below the existing HiGHS sentence (referencing "Solvers", "HiGHS",
"NEOS", and "NotImplementedError") so contributors won’t be confused by the
exposed NEOS config.

🪄 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: ASSERTIVE

Plan: Pro

Run ID: 0083aad4-e690-4809-a2b4-5b1b64eb802f

📥 Commits

Reviewing files that changed from the base of the PR and between cb703e5 and 50d4b5f.

📒 Files selected for processing (1)

• CONTRIBUTING.md