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

Refactor unclear wording re vulnerabilities #90

Merged
merged 2 commits into from
Oct 26, 2023
Merged

Conversation

greydevv
Copy link
Contributor

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and couldn’t find anything (or linked relevant results below)
  • If applicable, I’ve added docs and tests

Description of changes

I found the wording to be confusing regarding vulnerabilities in rehype-katex and rehype-mathjax. The current wording:

A vulnerability in them could open you to a cross-site scripting (XSS) attack. See their readmes for more info.

This wording makes it seem like there already exists a vulnerability in them and to visit the readme to learn more about said vulnerability. I believe the intended meaning is to warn about potential future vulnerabilities. My proposed wording change is:

If a vulnerability were to be introduced in them, it could open you up to a cross-site scripting (XSS) attack. See their readmes for more info.

@github-actions github-actions bot added 👋 phase/new Post is being triaged automatically 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Oct 25, 2023
readme.md Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (1f9df2b) 100.00% compared to head (c77b1be) 100.00%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #90   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           15        15           
  Lines         1823      1823           
=========================================
  Hits          1823      1823           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@wooorm wooorm changed the title Update unclear wording regarding vulnerabilities in README Refactor unclear wording re vulnerabilities Oct 26, 2023
@wooorm wooorm merged commit 260521f into remarkjs:main Oct 26, 2023
2 checks passed
@wooorm wooorm added 📚 area/docs This affects documentation 💪 phase/solved Post is done labels Oct 26, 2023
@wooorm
Copy link
Member

wooorm commented Oct 26, 2023

Thanks!

@github-actions

This comment has been minimized.

@github-actions github-actions bot removed the 🤞 phase/open Post is being triaged manually label Oct 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 area/docs This affects documentation 💪 phase/solved Post is done
Development

Successfully merging this pull request may close these issues.

3 participants