Skip to content

Latest commit

 

History

History
188 lines (137 loc) · 6.43 KB

process.md

File metadata and controls

188 lines (137 loc) · 6.43 KB

Operating Process

Please provide a PR in the following format:

  1. Create a branch with the following name:

proposal/<proposal-name>

For names, there may be no spaces, and please use snake case with lower case. i.e <>-<>

  1. Please copy the file from 000_template.md into proposals/<proposal-name>/<03d>_proposal.md.

For example, in the case of decentralized linkedin:

# clone this repo
git clone [email protected]:decentralized-identity/applications-and-implmentations-wg.git

## go into it

cd applications-and-implmentations-wg
# from the root 
mkdir proposals/decentralized-linkedin

# copy the file over
cp docs/000_template.md proposals/decentralized-linkedin/<03d>_proposal.md

# edit it
EDITOR docs/000_template.md proposals/decentralized-linkedin/<03d>_proposal.md # edit the file

# make a branch with it
git checkout -b proposal/decentralized-linkedin
git add . 
git commit -m "added decentralized linkedin proposal"

Now send a PR and request the CODEOWNERS to review the PR. If approved, they will approve it, convert the status to ACCEPTED.

Once it has been accepted, a repository with the following name:

appimp-<proposal-name> will be created. For example, in the case of decentralized linkedin:

appimp-decentralized-linkedin

Proposal States

Meta States

  • PROPOSED: This item has been proposed to the chairs of the WG, and is waiting for review.
  • ACCEPTED: This item has been accepted by the chairs of the WG into action.
  • PAUSED: This working item has been accepted but not currently being worked on.
  • PROMOTED: This working item has been promoted and has moved on to either a WG or another SDO.
  • CANCELLED: This working item has been cancelled. A cancelled item may not be re-activated.
  • ACTIVE: This working item has been accepted and is currently being worked on.
  • COMPLETED: This working item has been completed and is done and has not been promoted.
graph LR
  Proposed[PROPOSED] --> INREVIEW[In Review] --> |if accepted| ACCEPTED[ACCEPTED] 
  INREVIEW -->|if not accepted submit another proposal| DECLINED
 
  subgraph ActiveStates[Active States]
     ACTIVE{{ACTIVE}}
  end
  ACCEPTED --> ACTIVE
  subgraph InActiveStates[InActiveStates]
    CANCELLED{{CANCELLED}}
    COMPLETED{{COMPLETED}}
    PAUSED
    PROMOTED{{PROMOTED}}
  end
  ACTIVE --> CANCELLED{{CANCELLED}}
  ACTIVE --> COMPLETED{{COMPLETED}}
  ACTIVE --> PAUSED
  ACTIVE --> PROMOTED{{PROMOTED}}
  PAUSED --> ACTIVE
Loading

State Transition Governance Framework

Acceptance from a proposal requires a majority of the chairs to approve the working item within a 7 day timeframe from the notification. If a chair has not put a position between then, or requested additional time, it is assumed via in-absentia that it is a vote for approval.

State transitions past propsal requires a majority of WG chairs, and likely SC approval in the case that the promotion is a new WG except for PAUSED, which require at least a majority approval by the chairs of the WG.

Evaluation Criteria

Proposal Acceptance Criteria

  • consistent with WG charter
  • viable: participant interest
  • need established; doesn’t conflict with existing efforts
  • related to decentralized identity
  • Chairs may involve expert pool in case where idea assistance is required.

Proposal Promoted Criteria

  • Evaluated on an ad-hoc basis, but reasonable criteria MAY include:
    • On-brand for what DIF represents.
    • Work has been done, and artifacts are available for review.
    • Functioning code/work.
    • Use of decentralized identity standards / tech
    • viability (technical and participation)
    • consistent with DIF goals
    • Continual interest/activity in the Working Item for a long peroid of time.

Note: Any WI that wants to be promoted into a WG will need to go through the standard working group creation process, which includes Steering Committee approval.

Proposal Paused Criteria

  • No reasonable activity has been happening on this Working Item, but may re-visited in the future.
  • Reasonable activity MAY include:
    • Not enough members in a meeting over many consecutive meetings.
    • No activity in any of the items accepted over a period of time.

Proposal Cancelled Criteria

Cancellation can happen for some of the following reasons:

  • If a breach of the WG charter has been found, a Working Item MAY be cancelled.
  • If a proposal is obsolete and there's no reasonable way this can move forward.

Work Item Lead Responsibilites

As a lead of a working item, you take on the the following responsibilities:

  • Ensure all contributions are made in compliance with the code of conduct, contributing guides.
  • Ensure operating procedures are compliant with the charter.
  • Provide regular updates to the chairs about the progress of the efforts. The chairs may ask for you to attend a meeting built at a cadence.
  • Notify the chairs on decisions/states that may impact the group progress such as:
    • A chair leaving for some reason
    • A requirement for the working item to go on pause.
    • Other large changes to the working grop.

Working Group Structure

graph TB
      SC[DIF Steering Committee] --> LabsWG
      subgraph LabsWG
        direction TB
        WGChairs[WG Chairs] --> Mentors
        subgraph Work Item
          ProjectLeads
          Contributors
        end
        Mentors --> ProjectLeads
        ProjectLeads[Project Leads]
        ProjectLeads --> Contributors
      end
Loading

Roles

Chairs :
  • Designations: 3
  • Responsibilities:
    • Evaluating Work Item proposals.
    • Moving Working Items Across State
    • Empowering leads within a work item.
    • Ensuring fair and correct process.
    • Training leads / ensuring IPR protections across work items.
    • Ensuring compliance with DIF standards.
  • Process to modify: Chairs may be transferred via existing chairs/SC per the DIF guidelines.
Mentors :
  • Designations: Unlimited, but suggested around 10-20.
  • Responsibilities:
    • Provide guidance and support to project leads to help improve and enhance the project.
  • Process to modify
    • Chairs to edit the mentors.json with the name, email, start_date, description, socials, and tags of the mentor.
Project Leads
  • Designation: 1-2 per project
  • Create the working item
  • Communicate with Chairs on state changes.
  • Mangage calendar.
  • Create charter
  • Foster contributions and community involvement.
  • Process to modify: Chairs may modify the project leads.