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

Document our approach to accessibility #11860

Closed
laurent22 opened this issue Feb 19, 2025 · 1 comment · Fixed by #11863
Closed

Document our approach to accessibility #11860

laurent22 opened this issue Feb 19, 2025 · 1 comment · Fixed by #11863
Labels
documentation Documentation, web site, README high High priority issues

Comments

@laurent22
Copy link
Owner

laurent22 commented Feb 19, 2025

We should create a document to describe our approach in terms of accessibility. The document will drive development in general and ensures we don't introduce regressions over time and keep the apps (desktop and mobile) accessible.

The reader for this document would be a new developer who wants to contribute to Joplin. Because without knowing about accessibility it's almost certain that new developments will introduce regressions. May be particularly relevant if we participate in GSoC again, or even for ourselves as a way to review we took everything into consideration when adding a new feature.

The document should probably contain information such as:

  • What should be taken into consideration when creating new components
  • How can we verify that a change or new feature is accessible
    • Provide links to simple guides on how to setup screen readers on various platforms
    • Any other way to check?
  • How to add tests for accessibility to prevent regressions
    • Are there tests or eslint rules we can add to ensure that new components for example are accessible?
    • And describe how to manually add tests, if that's possible (maybe just linking to our existing test doc if that's sufficient)
  • Anything else?

WCAG 2 is massive obviously so we can't document everything so we should focus on the most important parts, so as to create a document that can be read in a relatively short time. As additional references, we can link to WCAG 2, WebAIM contrast checker, and other useful tools and documents.

@laurent22 laurent22 added documentation Documentation, web site, README high High priority issues labels Feb 19, 2025
@personalizedrefrigerator
Copy link
Collaborator

I've started working on this! Regarding ESLint rules, perhaps we could add eslint-plugin-react-native-a11y.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation, web site, README high High priority issues
Projects
None yet
2 participants