Documentation for adding new problems in contributing.md#410
Documentation for adding new problems in contributing.md#410tmigot merged 17 commits intoJuliaSmoothOptimizers:mainfrom
Conversation
…, including constraints, compatibility, meta fields, allocation, and scalability
…d, as suggested by validation analysis PDF
…n requirements for benchmarking, as suggested by validation analysis PDF
Clarified requirements for meta field completeness and validation.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #410 +/- ##
===========================================
- Coverage 99.80% 54.34% -45.47%
===========================================
Files 1084 1138 +54
Lines 12319 13371 +1052
===========================================
- Hits 12295 7266 -5029
- Misses 24 6105 +6081 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: Tangi Migot <tangi.migot@gmail.com>
Corrected punctuation and formatting in the contributing guidelines.
tmigot
left a comment
There was a problem hiding this comment.
Some comments. Don't hesitate to go into details.
Co-authored-by: Tangi Migot <tangi.migot@gmail.com>
There was a problem hiding this comment.
Pull request overview
This PR extends the contributor documentation with guidance for validating and reviewing newly added optimization problems, aiming to standardize expectations across ADNLPProblems and PureJuMP implementations.
Changes:
- Added a “Validating new problems” section with validation guidance (meta accuracy, consistency checks, scalable problems, least-squares handling).
- Added a structured reviewer checklist covering meta, definition, implementation, sanity checks, and zero-allocation expectations.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Added guidelines for handling Nonlinear Least Squares (NLS) problems in contributing documentation.
Co-authored-by: Tangi Migot <tangi.migot@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Tangi Migot <tangi.migot@gmail.com>
|
@arnavk23 I see that some comments still needs to be Resolved ? |
I have tried to resolve them but kept them active as I am a bit unsure. |
|
@tmigot Let's work further on this and get this merged as quickly as we can. |
Co-authored-by: Tangi Migot <tangi.migot@gmail.com>
Co-authored-by: Tangi Migot <tangi.migot@gmail.com>
@dpo @tmigot