ADAPT / Standard

ADAPT Standard data model issue management
https://adaptstandard.org
MIT License
7 stars 1 forks source link

AgGateway's ADAPT Standard documentation

ADAPT Standard documentation is available at https://adaptstandard.org.

ADAPT Standard issue management

Introduction

The purpose of this repository is to store the ADAPT Standard schema and related documentation, as well as to manage ADAPT Standard issues. The ADAPT Standard-related issues are managed in a GitHub project. Each issue is in a state as specified below.

Supplementary discussion page

For discussion content that stakeholders feel is not well supported by this repo, consider the following AgGateway Confluence page: ADAPT Standard changes discussion

GitHub Issue state diagram

connectSpec _ ADAPT Standard Issue Management

GitHub Issue states and connectCenter CC states

GitHub
Issue
State
connectCenter
CC State
Description
Approved Draft An Architecture Committee review team has approved the issue.
AC review Draft The submitter has the set of related issues (perhaps only one) ready to review with the ADAPT Committee.
Candidate Candidate The components associated with the issue are set to Candidate status in Score.
Discussion N/A The submitter would like to discuss the issue with the AC prior to creating/changing components in Score.
Implemented Draft The submitter regards that work on components they created/changed in Score is complete and has changed the status in Score to Draft.
Implementing WIP The submitter has created/changed components in Score and those changes are in WIP (work-in-progress) status in Score.
Member reveiew Release A draft release has been created in Score.
New N/A A submitter submitted the issue. The submitter may need to refine the issue content before it’s ready to transition Discussion or Implementing.
Ready for release Release The member review is complete with nothing left to process
Reconsider Draft or Candidate A member of the AC believes that, in the interest of ADAPT Standard quality, the issue should be reconsidered.

GitHub issue state transitions

From state To state Guard conditions
(i.e., what must be true for the transition to occur)
AC review Approved
  • AC approves the issue.
AC review Implementing
  • AC rejects the issue.
Approved Candidate
  • Components associated with the issues have been set to Candidate status in Score.
Candidate Reconsider
  • An AC member believes that, in the interest of quality, the issue should be reconsidered.
Discussion Implementing
  • Same as New to Implementing
Implemented AC review
  • Submitter is ready to review with AC.
Implementing Implemented
  • Submitter regards that work on components they created/changed in Score is complete and has changed the status in Score to Draft.
Member review Ready for release
  • Members have validated the release.
  • All issues have been processed from the member review.
Member review Reconsider
  • Same as Candidate to Reconsider
New Discussion
  • Submitter has determined that he/she wants to discuss the issue (and perhaps related ones) with AC prior to to creating/changing components.
  • The submitter has properly formatted the issue
    • The title is in the correct format.
    • The description in the correct format.
    • An appropriate milestone is specified.
    • Appropriate labels are set.
New Implementing
  • Submitter has properly formatted the issue (see New to Discussion)
  • Submitter is ready to create / change components in Score and those components are in WIP status in Score.
Ready for release End
  • ADAPT Standard is released and the issue is closed and archived.
Reconsider Implementing
  • AC reverses its earlier approval.
Start New
  • Submitter has an issue to submit.