Process

[sturobson]

How do we go from "we need X" to it being available for use? What should you do if a component is almost perfect but you need to add or change something slightly? What happens once a Pull Request is merged? At what point do we ask for feedback?

We already have a few pages on https://stable.visual-framework.dev that help understand how processes work a little. But there needs to be a larger document that 'covers everything'.

I was hoping to get this 'done' before finishing up - but I think where it is is probably best for you all to take on and improve.

Here's the 'work-in-progress' –

…

From ideation to release

A components path to production.

This is a working document to show the rough path a component goes from idea to production.

The work is never done.

Idea

A new idea should start and be discussed in a GitHub discussion.
An issue with an existing component not meeting requirements should be raised in a GitHub issue.

Design

Designs the components, with conversation with Development. Then iterates, if needed, on feedback from Development and stakeholder walkthroughs.

Development

Code the component,.
Iterate with Design.
Create a Pull Request.

Release

Merge the Pull Request on Github.

• This updates the development CSS file (as used on latest.visual-framework.dev).
  Release to NPM.
• This creates a ‘tagged’ release. So you can use all of the updated components from a single CSS file.
• This updates the individual components which you can choose to upgrade to or not.

[khawkins98]

Good stuff. As @sturobson mentions there are also a few pages on the docs that already get at this ... in fact we have quite a lot "stuff" on visual-framework.dev but we've not really fit it into the user journeys (our main target ones are: developers, page layout designers, stakeholders)

[khawkins98]

Addressed partly with #1563

[khawkins98]

https://stable.visual-framework.dev/guidance/creating-components/