[go: nahoru, domu]

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

Update pull_request_template.md to include accessibility compliance #14871

Closed
wants to merge 2 commits into from

Conversation

assuntad23
Copy link
Contributor

In an effort to enforce improvement of our accessibility compliance, we should include a checkbox for devs to remind them to check compliancy guidelines.

I've linked just to the headings.md file, but I'm sure there are other guidelines we could point to that are simple and concise pointers.

How to test the changes?

(Select all options that apply)

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.
  • Instructions for manual testing are as follows:
    1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]
  • not testable

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

In an effort to enforce improvement of our accessibility compliance, we should include a checkbox for devs to remind them to check compliancy guidelines. 

I've linked just to the headings.md file, but I'm sure there are other guidelines we could point to that are simple and concise pointers.
@assuntad23
Copy link
Contributor Author

@hexylena @ElectronicBlueberry @dannon In a meeting earlier today, @ElectronicBlueberry , @hujambo-dunia , and I talked about how to ensure that we are compliant with accessibility efforts. I suggested modifying the PR template as a reminder to devs to check with our latest compliancy guidelines.

Are there other guidelines created by us (Galaxy folks) or that are simple and concise enough that we should include them here?

What do you guys think about this update?

@assuntad23 assuntad23 marked this pull request as ready for review October 27, 2022 15:21
@github-actions github-actions bot added this to the 23.1 milestone Oct 27, 2022
@nsoranzo
Copy link
Member

I like the idea of an additional checklist to make it clearer what a developer should check before opening a PR, but maybe make it more general instead of specific to accessibility, so it can include e.g.: "I have run make format (for Python changes)" and "I have run make client-format (for client changes)"

@dannon
Copy link
Member
dannon commented Oct 27, 2022

I definitely support adding more general guidance and linking up documentation talking about accessibility, formatting, linting, etc., (lots of which is in CONTRIBUTING.md, -- this actually came up recently when someone didn't know where exactly to look for that). This is a great idea.

That said, the headings rule seems overly specific to call out in the PR template to me. This is the kind of thing we really just need to enforce in linting and testing. Linting is now available using vue-a11y, which will catch a lot of specific local-to-component a11y issues. It can't catch the heading one, though, since it's testing components in isolation. But that's where the work (on the ui/ux roadmap) towards automated axe testing comes in.

@dannon dannon modified the milestones: 23.0, 23.1 Dec 8, 2022
Co-authored-by: Helena <hexylena@galaxians.org>
@assuntad23
Copy link
Contributor Author

closing this because it does not seem like the approach that folks want to take, but I'm glad that it prompted some discussion.

@assuntad23 assuntad23 closed this Jan 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants