diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e430a951..04957fa4 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -5,7 +5,7 @@ This guide will help you get started with contributing. ## How Can I Contribute? -There are different ways of contributions. +There are different ways to contribute. ### Showcase Your Expertise @@ -20,27 +20,27 @@ By contributing to the conversation, you'll help grow the Playwright-BDD communi ### Create Bug Reports and Feature Requests If you find a bug or have an idea for a feature: -1. Check if the issue is already exist in the [Issues](https://github.com/vitalets/playwright-bdd/issues). +1. Check if the issue already exists in the [Issues](https://github.com/vitalets/playwright-bdd/issues). 2. If not, create a new issue! ### Contribute Code To contribute code: -1. Fork the [playwright-bdd](https://github.com/vitalets/playwright-bdd) repo. -2. Clone your fork to the local machine: - ``` - git clone https://github.com//playwright-bdd.git +1. Fork the [playwright-bdd](https://github.com/vitalets/playwright-bdd) repository. +2. Clone your fork to your local machine: + ```bash + git clone https://github.com//playwright-bdd.git ``` 3. Create a new branch for your feature or bug fix: - ```bash - git checkout -b my-feature - ``` + ```bash + git checkout -b my-feature + ``` 4. Perform the [development setup](#development-setup) 5. Make and commit your changes. 6. Push the changes to your fork: - ```bash - git push origin my-feature - ``` + ```bash + git push origin my-feature + ``` 7. Open [a pull request](https://github.com/vitalets/playwright-bdd/pulls) to the `main` branch. ## Development Setup @@ -54,15 +54,15 @@ To contribute code: ``` npx playwright install chromium ``` -3. Run tests +3. Run tests: ``` npm t ``` -## Useful dev commands +## Useful Dev Commands -### Run single test -Use the command below (use TAB after typing `test/` to autocomplete test path): +### Run a Single Test +Use the command below (use TAB after typing `test/` to autocomplete the test path): ``` npm run only test/<%test-dir%> ``` @@ -71,24 +71,24 @@ Example: npm run only test/special-tags ``` -### Switch Playwright version -This command will install provided Playwright version without saving it to `package.json`: +### Switch Playwright Version +This command will install the provided Playwright version without saving it to `package.json`: ``` npx cross-env PW=1.45 npm run pw ``` -### Install Playwright browsers +### Install Playwright Browsers This command will install `chromium` for the current Playwright version, without clearing previous browsers: ``` npm run pw:browsers ``` -### Check deprecated Playwright versions +### Check Deprecated Playwright Versions ``` npm show @playwright/test@1 deprecated ``` -### Clear Playwright compilation cache +### Clear Playwright Compilation Cache ``` npx playwright clear-cache ``` \ No newline at end of file