carbon-design-system / ibm-products

A Carbon-powered React component library for IBM Products
https://ibm-products.carbondesignsystem.com
Apache License 2.0
98 stars 138 forks source link

Draft a clear contribution process for Workgroups in boxnote #5480

Closed aubrey-oneal closed 2 months ago

aubrey-oneal commented 5 months ago

Recently we've seen workgroups struggle to understand the contribution process. While the new website is being built, we want to get out a boxnote of this process that we can share with workgroups immediately.

Pain points:

carrenelloyd commented 5 months ago

Now that we've merged teams (core + Products) the delivery process fundamentally changed to how workgroups operate currently, we have not communicated expectations to contributors.

carrenelloyd commented 5 months ago

After Step 4 on the Iterate tab https://pages.github.ibm.com/cdai-design/pal/contributing/contribution-framework/iterate

Step 5 Publishing

We made some minor changes when publishing new documentation to the Carbon for IBM Products PAL website.

After the DSIT playback, incorporate any feedback and update your work accordingly. A Carbon for IBM Product PAL maintainer will review your work during our next sprint (two weeks long) and may have additional feedback and questions that may not have been immediately evident during the DSIT playback.

Maintainer review

After you receive feedback from a Carbon for IBM Products maintainer, it's time to mock up the Gatsby website documentation in Figma utilizing the Gatsby theme styles and components Review your work for typos, or grammatical and styling errors, including using the correct image aspect ratios. <Do we want to provide an image example of Do's/Don't's?>

PR submission

After we triage and align the work with our spirits, the Carbon team will submit the PR on your behalf. Due to the volume of work we receive from our community, this could take a few weeks.

matthewgallo commented 4 months ago

@aubrey-oneal and/or @oliviaflory could you give this a review for @carrenelloyd?

aubrey-oneal commented 4 months ago

I think it reads well, Carrie! Could you just add in that that they should follow the docs templates provided? They can choose to write this in MDX or in Figma?