Agreed upon and publish process for working with large investments outside the partnership

[bstabler]

trafficstars

As discussed at the 09/16/21 meeting, the draft process and phases for working with large investments outside the partnership is:

• Before work

  • create issue assigned to agency owner and then consortium decides to add the issue to the project board as in progress

    • this is a soft approval to continue with the work with the idea that the contribution will be incorporated
    • our first real test of this process is the SANDAG cross border example
    • agency shares/documents why this work is valuable, for example:
      • adds functionality for special market models
      • the cross border model effort proves asim is extensible
      • the cross border model runtimes are 50% faster than the old version

  • the expectation is that the agency owner will share progress and discuss the work with the consortium as the work progresses

  • A bench reviewer may be decided upon at this point in the process and it should not be someone from the same organization as the author

• During work

  • add notes / discussion to the issue

• Submit work

  • create PR
    • code
    • PR notes on why changes
    • validation notebook (or evidence)
    • Contribution Review Criteria filled out
    • Example for testing / future

• Review work / approval

  • Reviewed by other bench contractor
  • This is what Task 5 budgets
  • Revisions as needed
  • Pull (or accept) the PR

Bug fixes / small stuff will be outside this formal process. We decided to try this out for the SANDAG cross border model improvements and then finalize this plan with the partners. @wusun2 will provide an overview on the next call and @danielsclint will do a mini-review to provide feedback.

[bstabler]

see #484

[bstabler]

We agreed on the 10/7 call that @joecastiglione will work on getting a process/governance docs update team together to formalize/memorialize this process.

[bstabler]

see also #496