Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Decision about the experimental code #1454

Merged
merged 5 commits into from
Jun 26, 2024
Merged

Conversation

literat
Copy link
Collaborator

@literat literat commented Jun 3, 2024

Description

I have tried to document the usage of the unstable_ prefix and made a decision for it.
It has been heavily inspired by the https://github.com/carbon-design-system/carbon/blob/5f79664cde29039ca272a4847a5b3c98c97d3e64/docs/experimental-code.md and it is like a rabbit hole. So I have tried to document also the usage of the feature flags and maybe a definition of what is the API and what not.

Additional context

There may be some consideration for the future, for instance, if we need to have some better logic around feature flags in SASS like this one https://github.com/carbon-design-system/carbon/blob/5f79664cde29039ca272a4847a5b3c98c97d3e64/packages/feature-flags/index.scss or have some kind of the FeatureFlags provider in the React like this: https://github.com/carbon-design-system/carbon/tree/5f79664cde29039ca272a4847a5b3c98c97d3e64/packages/react/src/components/FeatureFlags

So any advice is appreciated.

Issue reference

@literat literat requested review from pavelklibani, curdaj and a team as code owners June 3, 2024 11:26
@literat literat requested review from adamkudrna and crishpeen June 3, 2024 11:26
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 3, 2024
Copy link

netlify bot commented Jun 3, 2024

Deploy Preview for spirit-design-system-storybook ready!

Name Link
🔨 Latest commit 3a75309
🔍 Latest deploy log https://app.netlify.com/sites/spirit-design-system-storybook/deploys/667bdde2be8c2300089ef87a
😎 Deploy Preview https://deploy-preview-1454--spirit-design-system-storybook.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Jun 3, 2024

Deploy Preview for spirit-design-system ready!

Name Link
🔨 Latest commit 3a75309
🔍 Latest deploy log https://app.netlify.com/sites/spirit-design-system/deploys/667bdde2720eb900084c3578
😎 Deploy Preview https://deploy-preview-1454--spirit-design-system.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 96 (no change from production)
Accessibility: 93 (no change from production)
Best Practices: 100 (no change from production)
SEO: 82 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@coveralls
Copy link

coveralls commented Jun 3, 2024

Coverage Status

coverage: 78.141% (-0.6%) from 78.751%
when pulling 3a75309 on docs/decision-experimental-code
into 501833e on main.

docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/decisions/006-experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Show resolved Hide resolved
docs/decisions/006-experimental-code.md Outdated Show resolved Hide resolved
docs/decisions/006-experimental-code.md Show resolved Hide resolved
docs/decisions/006-experimental-code.md Outdated Show resolved Hide resolved
Copy link
Member

@crishpeen crishpeen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went over docs/contributtion/experimental-code.md only.

docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
@literat literat force-pushed the docs/decision-experimental-code branch 3 times, most recently from 9f4727e to 62964e4 Compare June 14, 2024 11:57
@literat
Copy link
Collaborator Author

literat commented Jun 14, 2024

@crishpeen Hopefully all fixed and rebased. I read it again and again today, and I hope I have reworded all sentences to fit our usage.

@literat literat requested a review from crishpeen June 14, 2024 11:58
@literat
Copy link
Collaborator Author

literat commented Jun 17, 2024

TODO: Link this decision to the existing components.

docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/feature-flags.md Outdated Show resolved Hide resolved
docs/contributtion/feature-flags.md Show resolved Hide resolved
docs/contributtion/feature-flags.md Outdated Show resolved Hide resolved
docs/contributtion/feature-flags.md Show resolved Hide resolved
packages/web/README.md Show resolved Hide resolved
@literat literat force-pushed the docs/decision-experimental-code branch from 62964e4 to 5fe2b4a Compare June 18, 2024 12:26
Copy link

nx-cloud bot commented Jun 18, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit b4e97dd. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


🟥 Failed Commands
cli run build --scope @lmc-eu/spirit-web* --ignore=@lmc-eu/spirit-demo-app
✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@literat literat force-pushed the docs/decision-experimental-code branch from b4e97dd to ca29a92 Compare June 24, 2024 10:35
@literat literat requested a review from crishpeen June 24, 2024 10:44
@literat literat force-pushed the docs/decision-experimental-code branch from 49ddf21 to 839d765 Compare June 24, 2024 10:48
docs/contributtion/experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/experimental-code.md Show resolved Hide resolved
docs/decisions/006-experimental-code.md Outdated Show resolved Hide resolved
docs/contributtion/feature-flags.md Outdated Show resolved Hide resolved
@literat literat force-pushed the docs/decision-experimental-code branch from 839d765 to 3a75309 Compare June 26, 2024 09:22
@literat literat merged commit 44ef6ef into main Jun 26, 2024
23 checks passed
@literat literat deleted the docs/decision-experimental-code branch June 26, 2024 09:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants