Skip to content

Introduce formal principle documentation to support contrib changes#3768

Merged
mrmundt merged 28 commits intoPyomo:mainfrom
mrmundt:addons-devel
Feb 9, 2026
Merged

Introduce formal principle documentation to support contrib changes#3768
mrmundt merged 28 commits intoPyomo:mainfrom
mrmundt:addons-devel

Conversation

@mrmundt
Copy link
Contributor

@mrmundt mrmundt commented Oct 21, 2025

Fixes None but starts to address #2460

Summary/Motivation:

Stage 1 of the changes inside pyomo.contrib is documenting a lot of different development principles that make the change a lot more reasonably understandable. This PR creates the new directories with their basic READMEs as well as creates documentation about our overarching development principles, including a teaser to the upcoming changes in contrib as part of their contents.

Changes proposed in this PR:

  • Create basic structure for addons and devel
  • Create new principles.rst documentation
  • Update the testing guidance because it was missing something kind of essential
  • (Tiny extra fix) Include doc/OnlineDocs/api in .gitignore because I have almost accidentally committed those files WAY too many times

Legal Acknowledgement

By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the BSD license.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@codecov
Copy link

codecov bot commented Oct 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.46%. Comparing base (f2d23a5) to head (dc97bbc).
⚠️ Report is 29 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3768      +/-   ##
==========================================
- Coverage   89.48%   89.46%   -0.02%     
==========================================
  Files         904      899       -5     
  Lines      105385   105370      -15     
==========================================
- Hits        94299    94266      -33     
- Misses      11086    11104      +18     
Flag Coverage Δ
builders 29.04% <ø> (-0.01%) ⬇️
default 83.57% <ø> (?)
expensive 35.52% <ø> (?)
linux 86.76% <ø> (-2.45%) ⬇️
linux_other 86.76% <ø> (+<0.01%) ⬆️
oldsolvers 29.68% <ø> (-0.01%) ⬇️
osx 82.91% <ø> (-0.01%) ⬇️
win 84.98% <ø> (-0.02%) ⬇️
win_other 84.98% <ø> (-0.02%) ⬇️
xpress95 ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mrmundt mrmundt requested a review from michaelbynum October 22, 2025 15:43
Copy link
Member

@blnicho blnicho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a bunch of minor edit suggestions but overall I think this looks great!

@mrmundt mrmundt requested a review from blnicho October 28, 2025 14:43
Copy link
Contributor

@michaelbynum michaelbynum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm only about halfway done, but here are a couple comments/questions.

Copy link
Contributor

@michaelbynum michaelbynum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have some minor comments, but I think this looks great overall.

Copy link
Contributor

@emma58 emma58 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks nice--I put a lot of ideas in the comments.

@blnicho blnicho moved this from Todo to Review In Progress in Pyomo 6.10 Nov 11, 2025
@mrmundt mrmundt requested review from emma58 and jsiirola January 26, 2026 22:56
@@ -0,0 +1,20 @@
# Pyomo Addons

The `pyomo.addons` directory contains **mostly stable extensions** to Pyomo
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The `pyomo.addons` directory contains **mostly stable extensions** to Pyomo
The `pyomo.addons` directory contains **stable extensions** to Pyomo

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I disagree. We explicitly say "mostly stable" everywhere else we talk about addons. This was intentional language to follow the idea of "some level of promised stability," but they still might change in small ways.

@mrmundt mrmundt requested a review from jsiirola February 4, 2026 16:22
Copy link
Member

@blnicho blnicho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found an issue with how some of the code snippets are rendered and I have a few minor edit suggestions.

@mrmundt mrmundt requested a review from blnicho February 9, 2026 15:35
@github-project-automation github-project-automation bot moved this from Review In Progress to Reviewer Approved in Pyomo 6.10 Feb 9, 2026
@mrmundt mrmundt merged commit 214685c into Pyomo:main Feb 9, 2026
90 of 95 checks passed
@github-project-automation github-project-automation bot moved this from Reviewer Approved to Done in Pyomo 6.10 Feb 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

6 participants