From 5aa8fa0573b2b146626b3fa0a2a4061d267047ed Mon Sep 17 00:00:00 2001 From: ksimanov Date: Mon, 28 Oct 2024 13:19:08 +0100 Subject: [PATCH] [chore] Update to contributing guide (#1717) Updated contributing guide ## Motivation and Context Updated with steps to improve install process and running tests with more up to date information ## How has this been tested? Code cannot be tested automatically so I have tested it only manually ## Types of changes - [ ] Bug fix (non-breaking change which fixes an issue). - [ ] New feature (non-breaking change which adds functionality). - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected). - [x] Nice improve. ## Checklist: - [ ] My code follows the code style of this project. - [x] I have updated the documentation accordingly or it's not required. - [ ] Unit tests are not broken. - [ ] I have added changelog note to corresponding `CHANGELOG.md` file with planned publish date. - [ ] I have added new unit tests on added of fixed functionality. --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ce58278e42..46a19a704b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ First of all, thank you for your interest in the library. We'd love to accept yo ### Prerequisites 1. Install the latest LTS version of [Node.js](https://nodejs.org/en). -2. Install [pnpm](https://pnpm.js.org) globally by running: `npm i -g pnpm`. +2. Install [pnpm](https://pnpm.js.org) globally by running: `npm i -g pnpm@8`. 3. Set up commit signing for your contributions. Follow these steps: - [Generate a GPG key](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key) - [Add your GPG key to your GitHub account](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account) @@ -64,6 +64,7 @@ To preview the website locally, run `pnpm website`. The site will be accessible Ensuring the accessibility of our components is a priority. We conduct automated screen reader tests, focusing on VoiceOver screen reader in Safari on macOS. Here's how to set up and run these tests: - To set up the environment, execute `pnpm vo-test:setup`. +- Open `voiceOver Utility > General` on your mac and enable the setting "Allow VoiceOver to be controlled with AppleScript" - Run the tests using the command `pnpm vo-test`. ## Caveats @@ -211,7 +212,7 @@ Here's how the plugin works: 3. The plugin modifies the component's JS code to add a `className` like `.SLink-xxx-enableVisited` if the `enableVisited` prop is provided. This happens for each selector. 4. The import statement for the `.shadow.css` file is removed, and the CSS rules from the file are moved to the compiled JS output. These rules operate like CSS-in-JS, and they are incorporated into the page's stylesheets from the JS code. -If users prefer to include CSS in the final bundle in the traditional way, they can follow the instructions provided in this [guide](https://developer.semrush.com/intergalactic/internal/production/). +If users prefer to include CSS in the final bundle in the traditional way, they can follow the instructions provided in this [guide](https://developer.semrush.com/intergalactic/get-started-guide/dev-starter-guide/production-tips). ## Conduct