Skip to content

Fix grammar error in Alert component story #368

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.

Sign up for GitHub

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

Open
sujaypawar wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix grammar error in Alert component story #368

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2bc822e
Fix grammar error in Alert component Storybook story
sujaypawar Feb 7, 2026
e4f3ebc
Fix ESLint error: escape apostrophe in JSX text
sujaypawar Feb 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/components/alert/alert.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ export const WithLongStringAndWithoutCloseButton: Story = {
variant: 'neutral',
content: (
<p className="m-0">
<b className="mr-1">Designer’s Note:</b>Adjusting or changing
<b className="mr-1">Designer&apos;s Note:</b>Adjusting or changing
components here will update it on all other pages or templates
Copy link
Copy Markdown

@github-actions github-actions Bot Feb 7, 2026

Choose a reason for hiding this comment

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

What: Correct the grammar in the text for clarity, as you've already done. However, it's a good practice to review the context of grammatical changes in the entire codebase to ensure it complies with proper standards before finalizing.

Why: While the current change improves clarity, consistent grammatical standards in all parts of the codebase contribute to better readability and professionalism in documentation and comments. Ensuring that all strings are grammatically correct avoids miscommunication and enhances user experience.

How: Continuously review string literals across the codebase, looking for any further instances of unclear phrasing or common grammatical errors to improve overall quality.

Copy link
Copy Markdown

@github-actions github-actions Bot Feb 7, 2026

Choose a reason for hiding this comment

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

What: The clarification in this code does not have security issues but it is still important to ensure that the content rendered (if coming from user input) is sanitized properly to avoid XSS risks. Ensure that content is safe and properly escaped in the future.

Why: Proper sanitization of inputs is vital for preventing XSS attacks. Although this particular change is benign, it is always a good practice to review how such content is handled in the rendering process to ensure security best practices are being followed.

How: Make sure to employ libraries or methods that sanitize HTML such as DOMPurify for content that is likely user-generated to ensure no malicious scripts are executed.

where it is been used
where it has been used
</p>
),
},
Expand Down