Skip to content

Commit

Permalink
[chore] Update to contributing guide (#1717)
Browse files Browse the repository at this point in the history
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

<!--- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->

- [ ] 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:

<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->

- [ ] 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.
  • Loading branch information
ksimanov authored and ilyabrower committed Oct 28, 2024
1 parent dba4684 commit 5aa8fa0
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 5aa8fa0

Please sign in to comment.