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

Form Label - Ensure Consistency between Storybook Documentation and Codebase Property Names #781

Closed
5 tasks done
angelicahoyss opened this issue Jan 12, 2024 · 1 comment · Fixed by #949
Closed
5 tasks done
Assignees
Labels
⭕ core team issue This is for the core team and should not be done by contributors ⌨️ dev issue Task is for developers 🎓 junior issue Good for juniors

Comments

@angelicahoyss
Copy link
Contributor

angelicahoyss commented Jan 12, 2024

Description / User Story

As a developer on the team,
I want to ensure consistency between the property names defined in the Storybook documentation for Form Label component
So that the Form Label component codebase accurately reflects the documented property names.

This user story outlines the need to maintain consistency between the documentation and the codebase regarding component property names. Each component is checked to ensure the property names in the codebase match the corresponding names in the Storybook documentation. If the discrepancies are found, they are listed in this table on the page "FormLabel",. Column Current Code Property Name describes how is the property currently named in the code. Column Desired Code Property Name is how the property should be named. Properties marked green don't need adjustment.


Acceptance Criteria

  • All Form Label component's property names that differ from Storybook documentation property names (listed in the above mentioned table) should be updated
  • Property 'variant' should be renamed to 'hasError' and re-written as a boolean type instead of LabelVariantType
  • The updated property names should not introduce any unintended side effects or issues in the functionality of the components
  • The library builds successfully, and there are no reported issues related to the property name updates
  • Props Excel has been updated / comments have been resolved and props changed from red to black font color > @thrbnhrtmnn or @angelicahoyss can support here
@angelicahoyss angelicahoyss added 🎓 junior issue Good for juniors ⌨️ dev issue Task is for developers ⭕ core team issue This is for the core team and should not be done by contributors labels Jan 12, 2024
@angelicahoyss angelicahoyss added this to the Prop alignment milestone Jan 17, 2024
@RubirajAccenture RubirajAccenture self-assigned this Feb 13, 2024
@thrbnhrtmnn
Copy link
Contributor

Hey @RubirajAccenture , I saw one issue on develop. Could you change the "hasError" prop, so that it is a boolean in Storybook? I think this is also how the property behaves in the component and it would also be more consistent with other hasError props, if it is a boolean here and if users turn this to "true", the error state is displayed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⭕ core team issue This is for the core team and should not be done by contributors ⌨️ dev issue Task is for developers 🎓 junior issue Good for juniors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants