Skip to content

Commit

Permalink
improve contributing md
Browse files Browse the repository at this point in the history
  • Loading branch information
vitalets committed Jan 26, 2025
1 parent f5f4a3a commit 7d8d672
Showing 1 changed file with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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/<YOU_NAME>/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/<YOUR_USERNAME>/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
Expand All @@ -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%>
```
Expand All @@ -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
```

0 comments on commit 7d8d672

Please sign in to comment.