IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-25 18:30:41 -06:00
Code Issues Packages Projects Releases Wiki Activity

Docs: added an accessibility section in the pull request guide (#36454)

Browse Source 
* Docs: added an accessibility section in the pull request guide

* added more points to the accessibility guideline

* fixes some grammar nits

* changed aria to capital case since its an acronym

* added a reference to the Grafana theme

* improved the wordings for better context
This commit is contained in:
Uchechukwu Obasi 2021-07-08 11:04:56 +01:00 committed by GitHub
parent c22905f864
commit f45d0a0b7a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
contribute/create-pull-request.md
View File

@ -16,7 +16,7 @@ If this is your first time contributing to an open-source project on GitHub, mak
To increase the chance of having your pull request accepted, make sure your pull request follows these guidelines: To increase the chance of having your pull request accepted, make sure your pull request follows these guidelines:
- Title and description matches the implementation. - Title and description matches the implementation.
- Commits within the pull request follow the [Formatting guidelines](#Formatting-guidelines). - Commits within the pull request follow the [Formatting guidelines](#Formatting-guidelines).
- The pull request closes one related issue. - The pull request closes one related issue.
- The pull request contains necessary tests that verify the intended behavior. - The pull request contains necessary tests that verify the intended behavior.
- If your pull request has conflicts, rebase your branch onto the main branch. - If your pull request has conflicts, rebase your branch onto the main branch.
@ -48,6 +48,13 @@ Pull requests that add or modify unit tests that are written in Jest must adhere
- Don't add snapshots tests. We are incrementally removing existing snapshot tests, we don't want more. - Don't add snapshots tests. We are incrementally removing existing snapshot tests, we don't want more.
- If an existing unit test is written in Enzyme, migrate it to RTL (React Testing Library), unless you’re fixing a bug. Bug fixes usually shouldn't include any bigger refactoring, so it’s ok to skip migrating the test to RTL. - If an existing unit test is written in Enzyme, migrate it to RTL (React Testing Library), unless you’re fixing a bug. Bug fixes usually shouldn't include any bigger refactoring, so it’s ok to skip migrating the test to RTL.
Pull requests that create new UI components or modify existing ones must adhere to the following accessibility guidelines:
- Use semantic HTML.
- Use ARIA roles, labels and other accessibility attributes correctly. Accessibility attributes should only be used when semantic HTML doesn't satisfy your use case.
- Use the [Grafana theme palette](/contribute/style-guides/themes.md) for styling. It contains colors with good contrast which aids accessibility.
- Use [RTL](https://testing-library.com/docs/dom-testing-library/api-accessibility/) for writing unit tests. It helps to create accessible components.
### Backend-specific guidelines ### Backend-specific guidelines
Please refer to the [backend style guidelines](/contribute/style-guides/backend.md). Please refer to the [backend style guidelines](/contribute/style-guides/backend.md).
@ -107,6 +114,6 @@ Make sure that the title for your pull request uses the same format as the subje
If your PR includes configuration changes, all of the following files must be changed correspondingly: If your PR includes configuration changes, all of the following files must be changed correspondingly:
* conf/defaults.ini - conf/defaults.ini
* conf/sample.ini - conf/sample.ini
* docs/sources/administration/configuration.md - docs/sources/administration/configuration.md