Definition of Done ⛱️

[jeanservaas]

Justification:

After several workshops and the Carbon/C4IBMP merger, there is a clear process that all future innovation/contribution must follow in adherence with the IBM's Product Development Lifecycle. The greater Carbon community needs to understand this process, especially since there is a publishing gate on the Product PAL now.

The purpose of this documentation is to explain the PDLC as it relates to Carbon to the community and then provide a clear checklist for contributors, so that they know what we mean be stable, we are aligned on expectations etc.

The goal is to publish this by the September 11th release of the new PAL site (on both the Carbon site and the C4IBMP site).

Tasks

Beta Give feedback

1. [DoD] Explore IA options for the Carbon site #4229
   role: content 📝 role: design ✏️ type: docs 📖 +3
2. [DoD] Review and refine content with SMEs #4230
   content: copy ✍️ role: design ✏️ type: docs 📖 +3
   
3. [DoD] Add with new content and IA changes to website #4256
   content: copy ✍️ role: design ✏️ +2
   
4. [DoD] Create images to illustrate PDLC concepts
5. [DoD] Refine PDLC + contribution process docs #4294
   content: copy ✍️ type: docs 📖 +2
   
6. [DoD] Define checklist for Patterns #4290
   0 of 3
   role: design ✏️ type: docs 📖 +2
7. [Feature request]: Carbon Innovation added to IA #4181
   content: copy ✍️ role: design ✏️ status: waiting for maintainer response 💬 type: enhancement 💡 +4
   
8. [DoD] Create a "Carbon Labs" area in Figma carbon-design-kit#872
   kit: figma role: design ✏️ +2
   
9. [DoD] Add LTS and deprecation info

Originial tasks

Tasks

• Figure out the IA on both the Carbon and the Product PAL sites. There is another issue, re: Carbon innovation that relates to this issue (see below); both pages need to be accounted for in the IA. We're aiming for the Contribution section to house both of these new pages...but this is a bit of a branding issue. Do we want to use the name Carbon Innovation (instead of Contribution) do we want to call all innovation "Carbon Labs?" Do we want to actually use the name Product Development Lifecycle in the IA? You get the picture.

• Vet code content checklist with devs The code checklist (esp. the API best practices) is pretty heavy at the moment; also, the testing checklist could potentially be broken up into another section. Have them review and try to simplify it.

• Vet design kit checklist with Juan and Rich This section is the most incomplete part of the checklist...probably because the Figma guild has it's own checklist for kit contributions and we're trying to kind of shorthand their checklist on our site. I think we need to decide whether we want to bring a shortened version of their checklist over here to the site, or just link out to it.

• Provide PDLC images here @jeanservaas can help with this. I think we need to decide whether we just want one image of the full PDLC or if we also want an image per phase.

• Finalize the content @aubrey-oneal provided the original version of this content in box and @jeanservaas pushed it further and fleshed it out in context. I'd like Aubrey and Anna to further review what I've done, assess the order of things, read my notes and finalize the content.

Related issues:

carbon-design-system/ibm-products#4996

#4181

Resources:

Aubrey's boxtnote
https://ibm.ent.box.com/notes/1532682148666

Figma file
https://www.figma.com/design/tI8fN4VQY90CQenDECTlCV/Definition_of_done?node-id=0-1&t=vxVpqYp7aYmr9ne3-1