Update guidance on experimental components to call them "incubating" #1249
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mollykreis
approved these changes
May 16, 2023
rajsite
reviewed
May 16, 2023
jattasNI
changed the title
jattasNI
commented
May 18, 2023
jattasNI
commented
May 18, 2023
atmgrifter00
approved these changes
May 19, 2023
rajsite
approved these changes
May 23, 2023
rajsite
reviewed
May 23, 2023
rajsite
reviewed
May 23, 2023
jattasNI
commented
Jun 1, 2023
….com/ni/nimble into experimental-components-contributing
1 task
jattasNI
added a commit
that referenced
this pull request
Jun 12, 2023
…rybook (#1292) # Pull Request ## 🤨 Rationale Following the guidance agreed upon in #1249, we want to promote the "Incubating" terminology to describe components that aren't ready for general use. ## 👩💻 Implementation 1. Add sections to Storybook for **Incubating** and **Components**. The latter was proposed in #1230 so it seems like a good direction for multiple reasons. 2. Add MDX docs for the Incubating section. 3. Add a link to the corresponding component issue from incubating stories. Update tooltip to use standard incubating header. 4. Rename WaferMap stories to "Wafer Map" to match other components which English naming not code naming (and since this change was already going to cause a Chromatic diff) ## 🧪 Testing <!--- Detail the testing done to ensure this submission meets requirements. Include automated/manual test additions or modifications, testing done on a local build, private CI run results, and additional testing not covered by automatic pull request validation. --> ## ✅ Checklist <!--- Review the list and put an x in the boxes that apply or ~~strike through~~ around items that don't (along with an explanation). --> - [x] I have updated the project documentation to reflect my changes or determined no changes are needed. --------- Co-authored-by: Milan Raj <rajsite@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
🤨 Rationale
We had a team discussion about encouraging more Nimble contributions for things like app-specific table columns. This update captures policies for those components in CONTRIBUTING.md
👩💻 Implementation
Update the "Experimental" section of CONTRIBUTING.md to call these components "Incubating" and provide more detailed guidance.
Small updates to related documentation about component status and semver.
🧪 Testing
N/A
✅ Checklist