From 386207385cf6c9fc35c4557493d54637be9c1c87 Mon Sep 17 00:00:00 2001 From: Jesse Attas Date: Tue, 1 Oct 2024 10:39:50 -0500 Subject: [PATCH] Improve CONTRIBUTING "Adding a new component" instructions (#2422) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # Pull Request ## ๐Ÿคจ Rationale While preparing materials for an upcoming contribution I noticed our root CONTRIBUTING didn't clearly capture the important parts of our process. ## ๐Ÿ‘ฉโ€๐Ÿ’ป Implementation Write better docs ## ๐Ÿงช Testing N/A ## โœ… Checklist - [X] I have updated the project documentation to reflect my changes or determined no changes are needed. --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4dff89c80c..6a9e417fba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,9 +48,9 @@ This repository uses the following tooling. See below for more info. ### Adding a new component -1. Write a spec describing the API and behavior of the component. See instructions for [component specs](/specs/README.md). -2. Ensure UX specs are up to date and tokens are generated. See instructions for [contributing to Nimble Tokens](/packages/nimble-tokens/CONTRIBUTING.md). -3. Expose any tokens in the token provider and add web component logic. See instructions for [contributing to Nimble Components](/packages/nimble-components/CONTRIBUTING.md). +1. Follow the instructions in [component specs](/specs/README.md) to approve the direction and create specs for interaction design, visual design, and implementation. +2. Ensure base tokens and icons are available. See instructions for [contributing to Nimble Tokens](/packages/nimble-tokens/CONTRIBUTING.md). +3. Build the web component, including adding theme-aware tokens, documentation, and component logic. See instructions for [contributing to Nimble Components](/packages/nimble-components/CONTRIBUTING.md). 4. Add wrappers for each framework. See instructions for [adding Angular wrappers](/packages/angular-workspace/nimble-angular/CONTRIBUTING.md). See instructions for [adding Blazor wrappers](/packages/blazor-workspace/NimbleBlazor/CONTRIBUTING.md). 5. Publish and use! ๐ŸŽ‰