OMLT - coin-or-foundation/tlc GitHub Wiki

Contribution Review Checklist for OMLT

https://github.com/cog-imperial/OMLT

Next step

  • last action: 2022-12-12

General

  • Project Description: Represent trained machine learning models as Pyomo optimization formulations
  • Contributor: Ruth Misener, [email protected]
  • Contact Date: 2022-09-14
  • Handler: Stefan Vigerske
  • Reviewer: Stefan Vigerske
  • Sent instructions: (date)

Legal

  • Received CSRO: (date)
  • Received DOL: (date)
  • OSI-approved license: modified BSD-3 license, should be fine

Classification

  • Classified (Level 1-5): (see ProjectCategories)

Code and Documentation

  • README/LICENSE files: (exists and reasonable) (date checked)
  • Project Roadmap (Level 1 only): (exists and reasonable) (date checked)
  • AUTHORS/INSTALL files (Level 2 and above): (exists and reasonable) (date checked)
  • Code builds (Level 2 and above): (date checked)
  • Documentation (Level 3 and above): (exists and reasonable) (date checked)
  • Unit test (Level 4 and above): (has one and passed) (date checked)
  • Project binaries (Level 5): (exist and function properly) (date checked)

Accepted

  • No (2022-12-12): project did not want to move into coin-or space on GitHub; COIN-OR currently requires projects to move into coin-or space

Establishing Project

  • PM named: (name) (date)
  • PM familiar with Guidelines and Procedures for Project Management: (date)
    • Legal issues
    • Tracking contributions
    • Responding to bugs
    • Using SVN
    • Using Trac
    • Setting up a static Web page
    • Standard practices (versioning and release, build procedures)
  • Parameters for project creation mailed to submission manager:
   # SVNPROJ  : the project's name in the SVN repository
   # PROJDESC : short project description
   # PM       : space separated list of project manager COIN-OR id's
   # PM_EMAIL : email address of the PM managing the mailing lists

  • PM subscribed to mailing list: (date)

  • Code imported: (date)

  • PM given write access: (date)

  • Trac page set up: (date)

  • XML page (projDesc.xml, see documentation in the file itself, which can be copied and adapted from here) set up: (date)

  • Project listed on projects list, with link to XML file, should happen automatically: (date)

    Old howto:

    • Check out svn repo CoinWeb/projects.
    • Read projects.csv into your favourite spreadsheet (or text editor). Add an appropriate line for the new project and write out a revised projects.csv.
    • Run the command project_list_short.pl projects.csv. This'll produce the file index.html.new and modify the file coin-or-projects.xml.
    • Copy (or move) index.html.new to index.html.
    • Finally, commit the modified projects.csv, index.html, and coin-or-projects.xml.

  • Project announcement: (date)

  • PM invited for full membership of COIN-OR (contact coin secretary): (date)

  • Moved this page to ArchivedChecklists: 2023-05-16