Updated Contributing guidelines#288
Merged
ParticularlyPythonicBS merged 1 commit intounstablefrom Apr 8, 2026
Merged
Conversation
ParticularlyPythonicBS
added
Maintenance
WalkthroughCONTRIBUTING.md was fully rewritten to replace prior generic contribution content with a structured “Contributing to Temoa” guide covering resources, help channels, development setup (Python 3.12+, uv, pre-commit), testing & infrastructure, code quality tools, PR process, Conventional Commits, and code style guidelines. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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 |
ParticularlyPythonicBS
force-pushed
the
contributor_file_update
branch
from
46061b5 to
50d4b5f
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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
📒 Files selected for processing (1)
CONTRIBUTING.md
ParticularlyPythonicBS
force-pushed
the
contributor_file_update
branch
from
50d4b5f to
d45a736
Compare
ParticularlyPythonicBS
force-pushed
the
contributor_file_update
branch
from
d45a736 to
a43c8c6
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
CONTRIBUTING.md (3)
55-57:⚠️ Potential issue | 🟡 MinorAdd explicit NEOS unsupported note in Solvers section.
This section still only names HiGHS. Please add one sentence that NEOS paths may exist but are currently unsupported (raise
NotImplementedError) to avoid contributor confusion.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 55 - 57, Update the "Solvers" section to explicitly state that NEOS solver paths are not supported: add one sentence after the HiGHS mention clarifying that while NEOS-related paths may be present in the codebase, they currently raise NotImplementedError and are unsupported to avoid contributor confusion; reference the "Solvers" heading and the NotImplementedError behavior in the sentence.
83-85:⚠️ Potential issue | 🟡 MinorFix MD031: surround fenced code blocks with blank lines.
At Lines 83, 89, and 103 (and their closing fences), add required blank lines around fenced code blocks, including within list items.
Also applies to: 89-95, 103-105
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 83 - 85, MD031 violations: the fenced code blocks (e.g., the block containing "uv run mypy temoa" and the other fenced blocks around lines 89-95 and 103-105) need blank lines before and after their opening and closing ``` fences, including when they appear inside list items; edit CONTRIBUTING.md to add a single blank line immediately above each opening ``` and immediately below each closing ``` so each fenced code block is surrounded by blank lines to satisfy the lint rule.
55-56:⚠️ Potential issue | 🟡 MinorFix MD022: surround these headings with blank lines.
At Lines 55, 71, 81, and 87, headings are adjacent to paragraph text. Add a blank line before and after each heading to satisfy markdownlint.
Also applies to: 71-72, 81-82, 87-88
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 55 - 56, The headings in CONTRIBUTING.md (notably "### Solvers" and the other headings noted at lines 71, 81, and 87) are adjacent to paragraph text and violate MD022; add a blank line both before and after each of those headings so each heading is separated from surrounding paragraphs (ensure a single empty line above and below "### Solvers" and the headings at lines 71, 81, and 87).
🤖 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`:
- Line 3: In CONTRIBUTING.md update the phrase "open source energy system model"
to the hyphenated form "open-source energy system model" in the sentence that
begins "Thank you for your interest in contributing to Temoa! Building a
sustainable energy future with an open source energy system model..." so the
adjective is correctly hyphenated for clarity and standard usage.
---
Duplicate comments:
In `@CONTRIBUTING.md`:
- Around line 55-57: Update the "Solvers" section to explicitly state that NEOS
solver paths are not supported: add one sentence after the HiGHS mention
clarifying that while NEOS-related paths may be present in the codebase, they
currently raise NotImplementedError and are unsupported to avoid contributor
confusion; reference the "Solvers" heading and the NotImplementedError behavior
in the sentence.
- Around line 83-85: MD031 violations: the fenced code blocks (e.g., the block
containing "uv run mypy temoa" and the other fenced blocks around lines 89-95
and 103-105) need blank lines before and after their opening and closing ```
fences, including when they appear inside list items; edit CONTRIBUTING.md to
add a single blank line immediately above each opening ``` and immediately below
each closing ``` so each fenced code block is surrounded by blank lines to
satisfy the lint rule.
- Around line 55-56: The headings in CONTRIBUTING.md (notably "### Solvers" and
the other headings noted at lines 71, 81, and 87) are adjacent to paragraph text
and violate MD022; add a blank line both before and after each of those headings
so each heading is separated from surrounding paragraphs (ensure a single empty
line above and below "### Solvers" and the headings at lines 71, 81, and 87).
🪄 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: 05d31588-b2c0-495d-bad9-0ddebf9b8c27
📒 Files selected for processing (1)
CONTRIBUTING.md
| # Contributing to Temoa | ||
|
|
||
| I'm really happy that you're interested in contributing to Temoa! Building a sustainable energy future with an open source energy system model takes a lot of effort, and we can use all the help we can get. | ||
| Thank you for your interest in contributing to Temoa! Building a sustainable energy future with an open source energy system model takes a lot of effort, and we welcome all contributions. |
There was a problem hiding this comment.
Use hyphenated adjective for clarity.
At Line 3, change “open source energy system model” to “open-source energy system model” for standard usage.
🧰 Tools
🪛 LanguageTool
[grammar] ~3-~3: Use a hyphen to join words.
Context: ...a sustainable energy future with an open source energy system model takes a lot o...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CONTRIBUTING.md` at line 3, In CONTRIBUTING.md update the phrase "open source
energy system model" to the hyphenated form "open-source energy system model" in
the sentence that begins "Thank you for your interest in contributing to Temoa!
Building a sustainable energy future with an open source energy system model..."
so the adjective is correctly hyphenated for clarity and standard usage.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit