Add Comment #16

TajwarSaiyeed · 2023-11-09T08:14:42Z

Added comment explanations to Accordion, Alert, Avatar and Badge Component in the React app. The comments aim to enhance code readability and make it easier for developers to understand the functionality of those Components. This improvement is intended to facilitate future maintenance and collaboration.

Changes:

[✅] Added comments
[✅] Clarified complex logic and functionality.
[✅] Improved overall code documentation.

Components

[✅] Accordion
[✅] Alert
[✅] Avatar
[✅] Badge

Utility Function

[✅] managing search data

Helper Function

[✅] exclude.ts
[✅] floating.ts
[✅] range.ts
[✅] rangeWithDots.ts
[✅] use-Floating.ts
[✅] uuid.ts
[✅] window-exists.ts

netlify · 2023-11-09T08:14:46Z

✅ Deploy Preview for keep-react-sm ready!

Name	Link
🔨 Latest commit	`ac150e1`
🔍 Latest deploy log	https://app.netlify.com/sites/keep-react-sm/deploys/6562a2a4d77a7500093e8fbb
😎 Deploy Preview	https://deploy-preview-16--keep-react-sm.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

Arifulislam5577 · 2023-11-09T10:56:03Z

Thank you @TajwarSaiyeed for your contribution,
Your feedback on the accordion component is greatly appreciated. If you're interested, we'd love to have your insights on other components as well. Your contributions make a significant impact, and we value your involvement.

TajwarSaiyeed · 2023-11-09T11:02:27Z

@Arifulislam5577
Thank you for the warm feedback! I'm glad my work on the accordion component is helpful. I'm definitely interested in contributing more and providing insights on other components. Excited to be a part of the project and looking forward to more collaborations!

TajwarSaiyeed · 2023-11-11T13:16:06Z

@Arifulislam5577

[✅] module-not-found path fix

…on.mdx

TajwarSaiyeed · 2023-11-19T12:50:08Z

@Arifulislam5577 @kausarpial
Hi,
Dear kindly check the update. I have added some of the components of keep react. kindly check and update it to main and also one thing that is

i will update all the remaining components.

Arifulislam5577 · 2023-11-19T13:20:09Z

src/components/Accordion/Accordion.stories.tsx

@@ -2,22 +2,48 @@ import type { Meta, StoryObj } from '@storybook/react'
 import { Accordion } from '.'
 import { removeFragment } from '../../helpers/mergeDeep'

+/**
+ * Meta information for the Accordion component.
+ */
 const meta: Meta<typeof Accordion> = {


Please don't add comments in any *.stories.tsx file.

Okey, I will Modify All the *.stories.tsx file and remove the comment

Arifulislam5577

No need to add comments to the css interface. Avoid stories.tsx and theme.ts file. Please add comment only component props.

like this

alwaysOpen?: boolean
/**

Determines whether to show the open/close icon for each accordion panel.
@type {boolean}
*/

Arifulislam5577 · 2023-11-19T13:23:07Z

src/components/Accordion/Accordion.tsx

+ *
+ * @interface AccordionProps
+ * @extends {PropsWithChildren<ComponentProps<'div'>>}
+ */
 export interface AccordionProps extends PropsWithChildren<ComponentProps<'div'>> {


It was good. Please follow this style and add comment only component props not any other code.

Arifulislam5577 · 2023-11-19T13:26:09Z

src/components/Accordion/AccordionTitle.tsx

+/**
+ * Interface representing the theme object for the KeepAccordionTitle component.
+ */
+
 export interface keepAccordionTitleTheme {


Don't do it and avoid comment in this type of interface. There is no need to add comments to the css interface.

Thanks for the review. i will modify all the commented file and will focus to not add the commnet into the *.stoies.tsx and *theme.tsx file

only focus to explain the component file

Good, Carry on.

Kindly check the latest commit, i have removed unnecessaries commnet, add comment only to component

Hi @TajwarSaiyeed,

Thank you for your valuable contribution! Your work will greatly benefit fellow developers navigating our component library. Making the codebase more readable directly from the component is a fantastic improvement.

However, I noticed two different comment styles, and it might be a bit confusing for contributors. If you could follow the first comment style you used in the accordion component, it would be excellent. Please follow this style and add only this 3 line as a comment, For example:

/** * Determines whether the accordion should always be open. * @type boolean * @default false */ alwaysOpen?: boolean;

Thanks again for your efforts!

Best regards,
Md Ariful Islam

@Arifulislam5577
Thank you for the review, you will see the changes soon.

TajwarSaiyeed · 2023-11-26T01:51:39Z

@Arifulislam5577
Hi Dear,
Hope you are doing well. kindly check the latest update. All component modified as you suggestion. It can be possible there will mistake, kindy update me if any mistake and also any suggestion if you have.

If all ok then update it

Arifulislam5577 · 2023-11-27T04:43:39Z

Hi @TajwarSaiyeed,

Thank you for your valuable contribution to our component library. Your efforts are greatly appreciated, and we look forward to seeing more contributions from you in the future. Keep up the excellent work!

Best regards,
Md Ariful Islam

TajwarSaiyeed · 2023-11-27T10:47:11Z

Hi @TajwarSaiyeed,

Thank you for your valuable contribution to our component library. Your efforts are greatly appreciated, and we look forward to seeing more contributions from you in the future. Keep up the excellent work!

Best regards, Md Ariful Islam

Hi Md Ariful Islam,

Thank you so much for your encouraging words! I'm thrilled to be part of the "keep react" project, and I'm glad my contribution was valuable. It's truly motivating to receive such positive feedback.

I'm eager to continue contributing to the project and have some exciting ideas in mind. I'm planning to work on creating a new card design (glass card, sliding card, ribon card, etc) and a hero component etc. now. I believe these additions will enhance the overall user experience and visual appeal of the project.

If there are specific requirements or guidelines for these components, please let me know. I want to ensure that my contributions align seamlessly with the project's vision.

Looking forward to your guidance and to sharing more great work with the team.

Best regards,
Tajwar Saiyeed Abid

Arifulislam5577 · 2023-11-27T11:07:34Z

Hi @TajwarSaiyeed,

Thank you for your enthusiastic message and, more importantly, for your valuable contributions to the "keep react" project. Your dedication and creativity are truly commendable!

We appreciate your eagerness to contribute further, and your proposed ideas for new card designs and hero components sound intriguing. However, currently, we are working within the constraints of our keep Design System, and adding new components that are not part of our Figma design may create inconsistencies.

We have an open issue on GitHub related to this, and your expertise could be invaluable in addressing and resolving this challenge. Alternatively, you're more than welcome to propose enhancements or features for our existing components, which align with our current design system.

We value your commitment and innovative spirit, and we're looking forward to seeing more of your impactful contributions. If you have any questions or need guidance, feel free to reach out.

Best regards,
Md Ariful Islam

Added: Comment/Explanation Accordion Component

f9e3e59

kausarpial requested a review from Arifulislam5577 November 9, 2023 09:02

Arifulislam5577 assigned TajwarSaiyeed Nov 9, 2023

Merge branch 'StaticMania:main' into main

fa4d854

TajwarSaiyeed and others added 9 commits November 9, 2023 23:23

Added: Comment/Explanation Alert Component

f50135c

added: explantion of utility functions

cb40c16

Merge branch 'StaticMania:main' into main

6f36caa

Added: Comment/Explanation Avatar Component

3dc4346

added: KeepThemes Explanation

f6eb4b7

added: Comment/Explanation Badge Component

e552bbf

Merge branch 'StaticMania:main' into main

f28fac1

added: explanation of helpers

4758a79

module-not-found path fix: carousel.mdx

336fbbf

TajwarSaiyeed and others added 13 commits November 12, 2023 07:58

added: doc for useCopy hook | remove duplicate attribute from accordi…

cfdc71d

…on.mdx

update

70a2f8f

Merge branch 'main' of https://github.com/TajwarSaiyeed/keep-react

5750622

Merge branch 'main' into main

677fb14

update

d7ff30a

Merge branch 'StaticMania:main' into main

bd67d11

Merge branch 'main' of https://github.com/StaticMania/keep-react

3cf9925

Merge branch 'StaticMania:main' into main

7b88523

Merge branch 'StaticMania:main' into main

fc81a09

Merge branch 'StaticMania:main' into main

77ef6d3

Merge branch 'StaticMania:main' into main

2bb9bcb

Merge remote-tracking branch 'upstream/main'

58753c7

added: breadcrumb, button, card, progress, upload

bf0f870

TajwarSaiyeed and others added 3 commits November 18, 2023 06:43

Merge remote-tracking branch 'upstream/main'

c8d69f0

added: explantion popover-floating-searchbar-spinner-slider-pagination

6d429e2

Merge branch 'StaticMania:main' into main

3087fb8

Arifulislam5577 reviewed Nov 19, 2023

View reviewed changes

TajwarSaiyeed and others added 2 commits November 21, 2023 22:49

added: explanation | remove unnecessary | update

4476fb1

Merge branch 'StaticMania:main' into main

d0949d3

TajwarSaiyeed requested a review from Arifulislam5577 November 21, 2023 16:56

TajwarSaiyeed changed the title ~~Added: Comment/Explanation Accordion Component~~ Add Comment Nov 23, 2023

TajwarSaiyeed and others added 2 commits November 25, 2023 19:17

Merge branch 'main' into main

b59077a

Added Comment to explain the component

ac150e1

Arifulislam5577 merged commit 01cd26f into StaticMania:main Nov 27, 2023
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Comment #16

Add Comment #16

TajwarSaiyeed commented Nov 9, 2023 •

edited

Loading

netlify bot commented Nov 9, 2023 •

edited

Loading

Arifulislam5577 commented Nov 9, 2023

TajwarSaiyeed commented Nov 9, 2023

TajwarSaiyeed commented Nov 11, 2023

TajwarSaiyeed commented Nov 19, 2023 •

edited

Loading

Arifulislam5577 Nov 19, 2023

TajwarSaiyeed Nov 19, 2023

Arifulislam5577 left a comment

Arifulislam5577 Nov 19, 2023

Arifulislam5577 Nov 19, 2023

TajwarSaiyeed Nov 19, 2023

Arifulislam5577 Nov 19, 2023

TajwarSaiyeed Nov 21, 2023

Arifulislam5577 Nov 23, 2023

TajwarSaiyeed Nov 23, 2023 •

edited

Loading

TajwarSaiyeed commented Nov 26, 2023

Arifulislam5577 commented Nov 27, 2023

TajwarSaiyeed commented Nov 27, 2023

Arifulislam5577 commented Nov 27, 2023

Add Comment #16

Add Comment #16

Conversation

TajwarSaiyeed commented Nov 9, 2023 • edited Loading

Changes:

Components

Utility Function

Helper Function

netlify bot commented Nov 9, 2023 • edited Loading

✅ Deploy Preview for keep-react-sm ready!

Arifulislam5577 commented Nov 9, 2023

TajwarSaiyeed commented Nov 9, 2023

TajwarSaiyeed commented Nov 11, 2023

TajwarSaiyeed commented Nov 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Arifulislam5577 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TajwarSaiyeed Nov 23, 2023 • edited Loading

Choose a reason for hiding this comment

TajwarSaiyeed commented Nov 26, 2023

Arifulislam5577 commented Nov 27, 2023

TajwarSaiyeed commented Nov 27, 2023

Arifulislam5577 commented Nov 27, 2023

TajwarSaiyeed commented Nov 9, 2023 •

edited

Loading

netlify bot commented Nov 9, 2023 •

edited

Loading

TajwarSaiyeed commented Nov 19, 2023 •

edited

Loading

TajwarSaiyeed Nov 23, 2023 •

edited

Loading