Update contributing page

[PtitBen]

Based on the feedback from Leanne and Victoria:

• [x] Link to the illustration and icon RFC tickets
• [x] Define the expectation options (snowflake, labs, straight, discovery, etc..

RFC template

• [x] update the "helper" for expectations

[PtitBen]

Leanne's feedback:

[15:20] Rob Tobias https://nucleus.design/guidelines/contributing/ - - It would be useful for people unfamiliar with this process to have a step by step of what needs to happen EG. Create you proposal, Add it to the proposals channel, attend the review meeting, etc etc.... Contributing [15:20] Rob Tobias To ensure the use of nucleus 'jargon' is minimal, as this could be confusing to people unfamiliar with nucleus language or using the docs / proposals form for the first time. EG. Snowflake, labs.......

[RobTobias123]

Related: https://github.com/centrica-engineering/nucleus/issues/733

[RobTobias123]

Links to the 'always open' RFCs to be included:

Illustrations: https://github.com/ConnectedHomes/nucleus/issues/3360

Icons: https://github.com/ConnectedHomes/nucleus/issues/3356

[RobTobias123]

Branch created for updates on Nucleus Docs = chore/update-contributions-page

[RobTobias123]

Written a concise 6 step guide to contributing icons and illustrations and inserted it just after the general contribution section. Intention is to link to this from other relevant pages such as Guidelines/Assets and the Components pages for ns-icon and ns-illustration. I was also considering that a visual graphic showing these steps may be beneficial to include...(thoughts welcomed).

PR for review please: https://github.com/centrica-engineering/nucleus-docs/pull/623

[RobTobias123]

Commit with added description and links to the process guidelines from the guidelines/assets page.

PR for review please: https://github.com/centrica-engineering/nucleus-docs/pull/623

[RobTobias123]

Committed links to the process guidelines on the components/ns-icon and ns-illustration page under the 'Guidance/Do and Don'ts'.

PR for review please: https://github.com/centrica-engineering/nucleus-docs/pull/623

[RobTobias123]

Added a list of the steps and links in an aside to the contributing page. Added a link in Step 1 to the Assets page where all icons are listed and displayed.

[RobTobias123]

With reference to the RFC intake form and defining the options, here's a suggestion for a short definition of the options for Snowflake and Labs as a explanatory note under the Expectations selector:

Snowflakes: Unique, one-off components specifically tailored for a particular function. There is a need for it to be added to the system but it doesn’t really get reused outside of its first use case.

Labs: A labs component is a conceptual one that can be created and performance tested live before being fully integrated to the system. It can expedite the process of getting things released and provide useful feedback.

Please suggest changes/additions if you want to.

For reference:

https://github.com/ConnectedHomes/nucleus/issues/new?assignees=&labels=RFC%2Cdraft&projects=ConnectedHomes%2Fnucleus%2F6&template=b--proposal.yaml&title=%5BRFC%5D+Title+of+the+Proposal

Do we need definitions and additions to the list for 'Straight' and 'Discovery' as per the scope above?

[PtitBen]

Labs: Labs is a new way for us to create time limited components, that can be used for learning and testing. The aim of these labs components is to help us move proposals forward and to gain an understanding of how they can be delivered. These have a 3 months shelf life, and don't require to come with a documentation, unit tests, etc...

---

We also have a full document detailing this. Maybe a page on Labs would be beneficial? Nucleus Labs.docx

[RobTobias123]

Merged approved PR #623 for the docs Contributing page.

[RobTobias123]

Labs is a new way for us to create time limited components, that can be used for learning and testing. The aim of these labs components is to help us move proposals forward and to gain an understanding of how they can be delivered. These have a 3 months shelf life, and don't require to come with a documentation, unit tests, etc.

Tried updating this YAML file and created a PR https://github.com/ConnectedHomes/nucleus/pull/3504 but seems to be failing on an npm test?

[RobTobias123]

Updated to use complete URLs as getting 404 from them when it went live.

PR for review/approval please: https://github.com/centrica-engineering/nucleus-docs/pull/624

[RobTobias123]

Merged/fixed.

[RobTobias123]

Labs is a new way for us to create time limited components, that can be used for learning and testing. The aim of these labs components is to help us move proposals forward and to gain an understanding of how they can be delivered. These have a 3 months shelf life, and don't require to come with a documentation, unit tests, etc.

Tried updating this YAML file and created a PR ConnectedHomes/nucleus#3504 but seems to be failing on an npm test?

After raising this yesterday, it is apparently expected at the moment and part of a different issue being looked into. The update to the description was not the cause.

[RobTobias123]

Updated the in page URLs - PR for review please:

https://github.com/centrica-engineering/nucleus-docs/pull/626

[RobTobias123]

Approved and merged.

[RobTobias123]

closing as complete